diff --git a/docs/dyn/addressvalidation_v1.v1.html b/docs/dyn/addressvalidation_v1.v1.html index bef17b7ede..e614e78b94 100644 --- a/docs/dyn/addressvalidation_v1.v1.html +++ b/docs/dyn/addressvalidation_v1.v1.html @@ -123,7 +123,7 @@

Method Details

The object takes the form of: { # The request for validating an address. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. The address being validated. Unformatted addresses should be submitted via `address_lines`. The total length of the fields in this input must not exceed 280 characters. Supported regions can be found [here](https://developers.google.com/maps/documentation/address-validation/coverage). The language_code value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system. The Address Validation API ignores the values in recipients and organization. Any values in those fields will be discarded and not returned. Please do not set them. + "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. # Required. The address being validated. Unformatted addresses should be submitted via `address_lines`. The total length of the fields in this input must not exceed 280 characters. Supported regions can be found [here](https://developers.google.com/maps/documentation/address-validation/coverage). The language_code value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system. The Address Validation API ignores the values in recipients and organization. Any values in those fields will be discarded and not returned. Please do not set them. "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", ], @@ -178,7 +178,7 @@

Method Details

"missingComponentTypes": [ # The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be `['street_number', 'route']` for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). **Note: you might see a missing component type when you think you've already supplied the missing component.** For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷3丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type `premise`, but the premise number is missing, so `missing_component_types` will contain `premise`. "A String", ], - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The post-processed address represented as a postal address. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The post-processed address represented as a postal 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", ], @@ -221,7 +221,7 @@

Method Details

"missingComponentTypes": [ # The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be `['street_number', 'route']` for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). **Note: you might see a missing component type when you think you've already supplied the missing component.** For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷3丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type `premise`, but the premise number is missing, so `missing_component_types` will contain `premise`. "A String", ], - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The post-processed address represented as a postal address. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The post-processed address represented as a postal 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", ], diff --git a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.childAccounts.sites.html b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.childAccounts.sites.html index 0bda1a73e5..8be7aae0b2 100644 --- a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.childAccounts.sites.html +++ b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.childAccounts.sites.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Platform Child Site for a specified Platform Child Account and site.

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

Lists Platform Child Sites for a specified Platform Child Account.

@@ -92,6 +95,27 @@

Method Details

Close httplib2 connections.
+
+ get(name, x__xgafv=None) +
Gets a Platform Child Site for a specified Platform Child Account and site.
+
+Args:
+  name: string, Required. The name of the platform child site to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Transparent Platform Child Site.
+  "domain": "A String", # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
+  "name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
+  "platformGroup": "A String", # Resource name of the Platform Group of the Platform Child Site.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Child Sites for a specified Platform Child Account.
diff --git a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
index 4c44d9a05e..fc4614ffd4 100644
--- a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
+++ b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
@@ -77,6 +77,9 @@ 

Instance Methods

close()

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Platform Group for a specified Platform and group.

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

Lists Platform Groups for a specified Platform.

@@ -89,6 +92,29 @@

Method Details

Close httplib2 connections.
+
+ get(name, x__xgafv=None) +
Gets a Platform Group for a specified Platform and group.
+
+Args:
+  name: string, Required. The name of the platform group to retrieve. Format: accounts/{account}/platforms/{platform}/groups/{group} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Transparent Platform Group.
+  "description": "A String", # Output only. Description of the PlatformGroup.
+  "name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
+  "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+    "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+  },
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Groups for a specified Platform.
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index 560f30b1d7..2d667d698a 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -154,7 +154,8 @@ 

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -238,7 +239,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -368,7 +370,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -381,6 +384,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -560,6 +566,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -672,7 +680,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -808,7 +817,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -836,6 +846,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1015,6 +1028,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1081,7 +1096,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1354,7 +1370,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1490,7 +1507,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1518,6 +1536,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1697,6 +1718,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1763,7 +1786,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 64ee3c1928..cb75c01fbc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -146,7 +146,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -198,7 +199,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -226,6 +228,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -405,6 +410,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -462,7 +469,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -514,7 +522,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -542,6 +551,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -721,6 +733,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -803,7 +817,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -855,7 +870,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -883,6 +899,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1062,6 +1081,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1130,7 +1151,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1182,7 +1204,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1210,6 +1233,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1389,6 +1415,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1465,7 +1493,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1517,7 +1546,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1545,6 +1575,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1724,6 +1757,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1782,7 +1817,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1834,7 +1870,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1862,6 +1899,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2041,6 +2081,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 405b58a505..7551d4a250 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -207,7 +207,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -291,7 +292,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -421,7 +423,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -434,6 +437,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -613,6 +619,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1604,7 +1612,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1740,7 +1749,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1768,6 +1778,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1947,6 +1960,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2013,7 +2028,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3705,7 +3721,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3841,7 +3858,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3869,6 +3887,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -4048,6 +4069,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -4114,7 +4137,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index bf83bcf2f8..7817b4badb 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -317,7 +317,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -405,7 +406,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -484,7 +486,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -766,7 +769,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -857,7 +861,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index d0773660fc..e98f5576c8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -158,7 +158,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -242,7 +243,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -372,7 +374,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -385,6 +388,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -564,6 +570,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -676,7 +684,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -812,7 +821,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -840,6 +850,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1019,6 +1032,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1085,7 +1100,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1586,7 +1602,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1722,7 +1739,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1750,6 +1768,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1929,6 +1950,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1995,7 +2018,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 42c5a5e2aa..b0d7d02af9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -236,7 +236,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -407,7 +408,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -585,7 +587,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -769,7 +772,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -968,7 +972,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index bade9af886..096c68c98a 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -152,7 +152,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -236,7 +237,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -366,7 +368,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -379,6 +382,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -558,6 +564,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -670,7 +678,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -806,7 +815,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -834,6 +844,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1013,6 +1026,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1079,7 +1094,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1903,7 +1919,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2039,7 +2056,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2067,6 +2085,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2246,6 +2267,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2312,7 +2335,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 737c0bf640..3b773ba44b 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -156,7 +156,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -242,7 +243,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -377,7 +379,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -390,6 +393,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -576,6 +582,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -690,7 +698,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -831,7 +840,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -859,6 +869,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1045,6 +1058,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1113,7 +1128,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1391,7 +1407,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1532,7 +1549,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1560,6 +1578,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1746,6 +1767,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1814,7 +1837,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index b07f1415ef..5b1e7d57e9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -148,7 +148,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -202,7 +203,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -230,6 +232,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -416,6 +421,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -475,7 +482,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -529,7 +537,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -557,6 +566,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -743,6 +755,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -827,7 +841,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -881,7 +896,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -909,6 +925,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1095,6 +1114,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1165,7 +1186,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1219,7 +1241,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1247,6 +1270,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1433,6 +1459,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1511,7 +1539,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1565,7 +1594,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1593,6 +1623,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1779,6 +1812,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1839,7 +1874,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1893,7 +1929,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1921,6 +1958,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2107,6 +2147,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index bfd18f8d94..9cd0d4133f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -194,7 +194,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -336,7 +337,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -364,6 +366,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -550,6 +555,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -598,7 +605,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -740,7 +748,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -768,6 +777,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -954,6 +966,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -1051,7 +1065,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1193,7 +1208,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1221,6 +1237,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1407,6 +1426,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -1455,7 +1476,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1597,7 +1619,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1625,6 +1648,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1811,6 +1837,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 0b1659e66e..9cb776496e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -218,7 +218,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -304,7 +305,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -439,7 +441,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -452,6 +455,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -638,6 +644,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1790,7 +1798,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1931,7 +1940,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1959,6 +1969,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2145,6 +2158,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2213,7 +2228,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4084,7 +4100,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4225,7 +4242,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4253,6 +4271,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -4439,6 +4460,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -4507,7 +4530,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 8ac8a7c8a4..94669cb1f9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -278,7 +278,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -326,7 +327,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -578,7 +580,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -658,7 +661,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -706,7 +710,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -785,7 +790,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -833,7 +839,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -910,7 +917,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -958,7 +966,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 5d7a88e828..33eb6cd5b0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1181,7 +1181,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1240,7 +1241,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 711718edbd..60e1ea212a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -376,7 +376,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -473,7 +474,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -554,7 +556,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1120,7 +1123,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1213,7 +1217,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 9990bac54f..a26b612a3d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -172,7 +172,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -258,7 +259,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -393,7 +395,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -406,6 +409,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -592,6 +598,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -778,7 +786,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -919,7 +928,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -947,6 +957,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1133,6 +1146,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1201,7 +1216,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1794,7 +1810,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1935,7 +1952,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1963,6 +1981,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2149,6 +2170,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2217,7 +2240,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html new file mode 100644 index 0000000000..672ad728af --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . examples

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

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

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 5c6d15ea05..176e9632ac 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -74,6 +74,11 @@

Vertex AI API . projects . locations . reasoningEngines

Instance Methods

+

+ examples() +

+

Returns the examples Resource.

+

memories()

diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 2643226f29..e689c147d1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -161,7 +161,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 4f460e6ffd..388d4d7abf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -171,7 +171,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 56640f9f47..36962f3603 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -182,6 +182,8 @@

Method Details

"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -252,7 +254,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -362,7 +365,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -479,6 +483,8 @@

Method Details

"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -549,7 +555,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -659,7 +666,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -783,6 +791,8 @@

Method Details

"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -853,7 +863,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -963,7 +974,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1093,6 +1105,8 @@

Method Details

"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -1163,7 +1177,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1273,7 +1288,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1418,6 +1434,8 @@

Method Details

"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -1488,7 +1506,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1598,7 +1617,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 1c8e3edf18..7b0c3a07f3 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -160,7 +160,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -246,7 +247,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -381,7 +383,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -394,6 +397,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -580,6 +586,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -694,7 +702,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -835,7 +844,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -863,6 +873,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -1049,6 +1062,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1117,7 +1132,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2542,7 +2558,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2683,7 +2700,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2711,6 +2729,9 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "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 128 function declarations can be provided. @@ -2897,6 +2918,8 @@

Method Details

"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2965,7 +2988,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index fd7005c839..712f579567 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -161,7 +161,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index be1760a8c4..b2a7dc0f4b 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -166,7 +166,8 @@

Method Details

"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 0cacd7bd76..d3e4f5970a 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -157,7 +157,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -305,7 +305,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -544,7 +544,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -739,7 +739,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -876,7 +876,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index f1e574d723..4133fd4d00 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -294,7 +294,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -505,7 +505,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -824,7 +824,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1070,7 +1070,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1270,7 +1270,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1531,7 +1531,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1753,7 +1753,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 7210e3c106..a316d2dccd 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -184,7 +184,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -365,7 +365,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -637,7 +637,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -869,7 +869,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -1039,7 +1039,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index cfc93d0e73..2aab352726 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -293,7 +293,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -503,7 +503,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -821,7 +821,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1066,7 +1066,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1265,7 +1265,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1525,7 +1525,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1746,7 +1746,7 @@

Method Details

"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 94d3754f04..40c5a8da28 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -184,7 +184,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -364,7 +364,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -635,7 +635,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -866,7 +866,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -1035,7 +1035,7 @@

Method Details

}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 293f944515..5d6c0bb948 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -1059,6 +1059,11 @@

Method Details

"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. }, }, + "subpropertySyncConfig": { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. # A snapshot of a SubpropertySyncConfig resource in change history. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 + }, }, "resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing. "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history. @@ -1579,6 +1584,11 @@

Method Details

"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. }, }, + "subpropertySyncConfig": { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. # A snapshot of a SubpropertySyncConfig resource in change history. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 + }, }, }, ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index cb534b5c5a..2a588d509b 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -174,6 +174,11 @@

Instance Methods

Returns the subpropertyEventFilters Resource.

+

+ subpropertySyncConfigs() +

+

Returns the subpropertySyncConfigs Resource.

+

acknowledgeUserDataCollection(property, body=None, x__xgafv=None)

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

@@ -753,6 +758,7 @@

Method Details

The object takes the form of: { # Request message for CreateSubproperty RPC. + "customDimensionAndMetricSynchronizationMode": "A String", # Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics "subproperty": { # A resource message representing a Google Analytics property. # Required. The subproperty to create. "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" "createTime": "A String", # Output only. Time when the entity was originally created. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html b/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html new file mode 100644 index 0000000000..d16c49c1c2 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html @@ -0,0 +1,192 @@ + + + +

Google Analytics Admin API . properties . subpropertySyncConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Lookup for a single Subproperty Sync Config.

+

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

+

List all Subproperty Sync Configs on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Subproperty Sync Config.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Lookup for a single Subproperty Sync Config.
+
+Args:
+  name: string, Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
+  "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to.
+  "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
+  "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List all Subproperty Sync Configs on a property.
+
+Args:
+  parent: string, Required. Resource name of the property. Format: properties/property_id Example: properties/123 (required)
+  pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` 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 ListSubpropertySyncConfigs RPC.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "subpropertySyncConfigs": [ # List of Subproperty Sync Configs.
+    { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
+      "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to.
+      "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
+      "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
+    },
+  ],
+}
+
+ +
+ 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 Subproperty Sync Config.
+
+Args:
+  name: string, Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
+  "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to.
+  "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
+  "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
+}
+
+  updateMask: string, Optional. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
+  "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to.
+  "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
+  "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index b69e1ae837..7b8a93fa2e 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -91,7 +91,7 @@

Instance Methods

Enrolls an enterprise with the calling EMM.

generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None)

-

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.

+

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details.

generateSignupUrl(adminEmail=None, allowedDomains=None, callbackUrl=None, x__xgafv=None)

Generates a sign-up URL.

@@ -276,7 +276,7 @@

Method Details

generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None) -
Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.
+  
Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details.
 
 Args:
   enterpriseId: string, Required. The ID of the enterprise. (required)
@@ -290,7 +290,7 @@ 

Method Details

Returns: An object of the form: - { # Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available. + { # Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. "url": "A String", # A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe. }
diff --git a/docs/dyn/androidmanagement_v1.enterprises.html b/docs/dyn/androidmanagement_v1.enterprises.html index 6ef06d913d..8179f9a8d4 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.html +++ b/docs/dyn/androidmanagement_v1.enterprises.html @@ -120,7 +120,7 @@

Instance Methods

Permanently deletes an enterprise and all accounts and data associated with it. Warning: this will result in a cascaded deletion of all AM API devices associated with the deleted enterprise. Only available for EMM-managed enterprises.

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

-

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.

+

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide (https://developers.google.com/android/management/upgrade-an-enterprise) for more details.

get(name, x__xgafv=None)

Gets an enterprise.

@@ -292,7 +292,7 @@

Method Details

generateEnterpriseUpgradeUrl(name, body=None, x__xgafv=None) -
Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.
+  
Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide (https://developers.google.com/android/management/upgrade-an-enterprise) for more details.
 
 Args:
   name: string, Required. The name of the enterprise to be upgraded in the form enterprises/{enterpriseId}. (required)
diff --git a/docs/dyn/apigee_v1.organizations.apps.html b/docs/dyn/apigee_v1.organizations.apps.html
index 6b127f71c4..ab56f40c17 100644
--- a/docs/dyn/apigee_v1.organizations.apps.html
+++ b/docs/dyn/apigee_v1.organizations.apps.html
@@ -175,7 +175,7 @@ 

Method Details

keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`. pageSize: integer, Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "page_size" is supported from ver 1.10.0 and above. pageToken: string, Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above. - rows: string, Optional. Maximum number of app IDs to return. Defaults to 10000. + rows: string, Optional. Maximum number of app IDs to return. Defaults to 1000. startKey: string, Returns the list of apps starting from the specified app ID. status: string, Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`. x__xgafv: string, V1 error format. diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index e6bd553616..0ff4e7cb0c 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -319,6 +319,7 @@

Method Details

"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -468,6 +469,7 @@

Method Details

"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -848,6 +850,7 @@

Method Details

"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -922,6 +925,7 @@

Method Details

"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. diff --git a/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 0000000000..2923e2b591 --- /dev/null +++ b/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +

App Engine Admin API . projects . locations . applications . authorizedCertificates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)

+

Uploads the specified SSL certificate.

+

+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)

+

Deletes the specified SSL certificate.

+

+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)

+

Gets the specified SSL certificate.

+

+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+

Lists all SSL certificates the user is authorized to administer.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None) +
Uploads the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None) +
Deletes the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None) +
Gets the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  view: string, Controls the set of fields returned in the GET response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists all SSL certificates the user is authorized to administer.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  pageSize: integer, Maximum results to return per page.
+  pageToken: string, Continuation token for fetching the next page of results.
+  view: string, Controls the set of fields returned in the LIST response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  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 AuthorizedCertificates.ListAuthorizedCertificates.
+  "certificates": [ # The SSL certificates the user is authorized to administer.
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+      "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+        "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+        "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+      },
+      "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+      "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+      "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+        "A String",
+      ],
+      "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+      "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+      "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+        "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+        "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+      },
+      "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+      "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None) +
Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1.projects.locations.applications.html b/docs/dyn/appengine_v1.projects.locations.applications.html index 2635e648eb..e7dd6fbd1a 100644 --- a/docs/dyn/appengine_v1.projects.locations.applications.html +++ b/docs/dyn/appengine_v1.projects.locations.applications.html @@ -74,6 +74,11 @@

App Engine Admin API . projects . locations . applications

Instance Methods

+

+ authorizedCertificates() +

+

Returns the authorizedCertificates Resource.

+

authorizedDomains()

diff --git a/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 0000000000..9b1e0c44b8 --- /dev/null +++ b/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +

App Engine Admin API . projects . locations . applications . authorizedCertificates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)

+

Uploads the specified SSL certificate.

+

+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)

+

Deletes the specified SSL certificate.

+

+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)

+

Gets the specified SSL certificate.

+

+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+

Lists all SSL certificates the user is authorized to administer.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None) +
Uploads the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None) +
Deletes the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None) +
Gets the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  view: string, Controls the set of fields returned in the GET response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists all SSL certificates the user is authorized to administer.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  pageSize: integer, Maximum results to return per page.
+  pageToken: string, Continuation token for fetching the next page of results.
+  view: string, Controls the set of fields returned in the LIST response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  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 AuthorizedCertificates.ListAuthorizedCertificates.
+  "certificates": [ # The SSL certificates the user is authorized to administer.
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+      "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+        "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+        "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+      },
+      "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+      "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+      "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+        "A String",
+      ],
+      "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+      "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+      "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+        "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+        "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+      },
+      "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+      "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None) +
Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1alpha.projects.locations.applications.html b/docs/dyn/appengine_v1alpha.projects.locations.applications.html index d138ba69ad..ba85f113f7 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.applications.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.applications.html @@ -74,6 +74,11 @@

App Engine Admin API . projects . locations . applications

Instance Methods

+

+ authorizedCertificates() +

+

Returns the authorizedCertificates Resource.

+

authorizedDomains()

diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 0000000000..58f0236243 --- /dev/null +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +

App Engine Admin API . projects . locations . applications . authorizedCertificates

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)

+

Uploads the specified SSL certificate.

+

+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)

+

Deletes the specified SSL certificate.

+

+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)

+

Gets the specified SSL certificate.

+

+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)

+

Lists all SSL certificates the user is authorized to administer.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)

+

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None) +
Uploads the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None) +
Deletes the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None) +
Gets the specified SSL certificate.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  view: string, Controls the set of fields returned in the GET response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ +
+ list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists all SSL certificates the user is authorized to administer.
+
+Args:
+  projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+  locationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required)
+  pageSize: integer, Maximum results to return per page.
+  pageToken: string, Continuation token for fetching the next page of results.
+  view: string, Controls the set of fields returned in the LIST response.
+    Allowed values
+      BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date.
+      FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.
+  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 AuthorizedCertificates.ListAuthorizedCertificates.
+  "certificates": [ # The SSL certificates the user is authorized to administer.
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+      "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+        "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+        "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+      },
+      "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+      "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+      "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+        "A String",
+      ],
+      "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+      "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+      "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+        "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+        "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+      },
+      "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+      "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None) +
Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+
+Args:
+  projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+  updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+  "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+    "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
+    "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+  },
+  "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+  "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+  "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+    "A String",
+  ],
+  "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+  "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+  "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
+    "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
+    "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
+  },
+  "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+  "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.html b/docs/dyn/appengine_v1beta.projects.locations.applications.html index 09e8377b03..9c31890d9a 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.applications.html +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.html @@ -74,6 +74,11 @@

App Engine Admin API . projects . locations . applications

Instance Methods

+

+ authorizedCertificates() +

+

Returns the authorizedCertificates Resource.

+

authorizedDomains()

diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html index ee1e865f19..ae7654c93f 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html @@ -115,6 +115,8 @@

Method Details

{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -223,6 +225,8 @@

Method Details

{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -270,6 +274,8 @@

Method Details

"backupPlanAssociations": [ # The list of Backup Plan Associations in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. { # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -327,6 +333,8 @@

Method Details

{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index 3b2f1eb5cc..f87669065a 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -74,6 +74,11 @@

Backup and DR Service API . projects . locations . backupPlans

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

@@ -92,6 +97,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Update a BackupPlan

Method Details

close() @@ -146,6 +154,8 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -273,6 +283,8 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -340,6 +352,8 @@

Method Details

}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -368,4 +382,92 @@

Method Details

+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Update a BackupPlan
+
+Args:
+  name: string, Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
+  "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+    { # `BackupRule` binds the backup schedule to a retention policy.
+      "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
+      "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+      "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+        "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+          "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+          "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+        },
+        "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          42,
+        ],
+        "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+          "A String",
+        ],
+        "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).
+        "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+          "A String",
+        ],
+        "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+        "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+        "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          "dayOfWeek": "A String", # Required. Specifies the day of the week.
+          "weekOfMonth": "A String", # Required. Specifies the week of the month.
+        },
+      },
+    },
+  ],
+  "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+  "backupVaultServiceAccount": "A String", # Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+  "createTime": "A String", # Output only. When the `BackupPlan` was created.
+  "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+  "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+  "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+  "resourceType": "A String", # Required.
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "state": "A String", # Output only. The `State` for the `BackupPlan`.
+  "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. When the `BackupPlan` 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 t he 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. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan 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 the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.
+  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/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html new file mode 100644 index 0000000000..d2743901ab --- /dev/null +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html @@ -0,0 +1,257 @@ + + + +

Backup and DR Service API . projects . locations . backupPlans . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single BackupPlanRevision.

+

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

+

Lists BackupPlanRevisions in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single BackupPlanRevision.
+
+Args:
+  name: string, Required. The resource name of the `BackupPlanRevision` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
+  "backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
+    "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+      { # `BackupRule` binds the backup schedule to a retention policy.
+        "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
+        "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+        "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+          "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+            "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+            "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+          },
+          "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+            42,
+          ],
+          "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+            "A String",
+          ],
+          "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).
+          "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+            "A String",
+          ],
+          "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+          "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+          "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+            "dayOfWeek": "A String", # Required. Specifies the day of the week.
+            "weekOfMonth": "A String", # Required. Specifies the week of the month.
+          },
+        },
+      },
+    ],
+    "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+    "backupVaultServiceAccount": "A String", # Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+    "createTime": "A String", # Output only. When the `BackupPlan` was created.
+    "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+    "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+    "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+      "a_key": "A String",
+    },
+    "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+    "resourceType": "A String", # Required.
+    "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+    "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+    "state": "A String", # Output only. The `State` for the `BackupPlan`.
+    "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+      "A String",
+    ],
+    "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+  },
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "state": "A String", # Output only. Resource State
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists BackupPlanRevisions in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Cloud BackupDR, locations map to GCP regions, for e.g. **us-central1**. (required)
+  pageSize: integer, Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` 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:
+
+    { # The response message for getting a list of `BackupPlanRevision`.
+  "backupPlanRevisions": [ # The list of `BackupPlanRevisions` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
+      "backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
+        "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+          { # `BackupRule` binds the backup schedule to a retention policy.
+            "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
+            "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+            "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+              "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+                "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+                "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+              },
+              "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+                42,
+              ],
+              "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+                "A String",
+              ],
+              "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).
+              "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+                "A String",
+              ],
+              "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+              "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+              "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+                "dayOfWeek": "A String", # Required. Specifies the day of the week.
+                "weekOfMonth": "A String", # Required. Specifies the week of the month.
+              },
+            },
+          },
+        ],
+        "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+        "backupVaultServiceAccount": "A String", # Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+        "createTime": "A String", # Output only. When the `BackupPlan` was created.
+        "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+        "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+        "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+          "a_key": "A String",
+        },
+        "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+        "resourceType": "A String", # Required.
+        "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+        "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+        "state": "A String", # Output only. The `State` for the `BackupPlan`.
+        "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+          "A String",
+        ],
+        "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+      },
+      "createTime": "A String", # Output only. The timestamp that the revision was created.
+      "name": "A String", # Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
+      "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+      "state": "A String", # Output only. Resource State
+    },
+  ],
+  "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBackupPlanRevisions` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
+  "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/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index de4580ae25..1b2001b72e 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -349,6 +349,8 @@

Method Details

"expireTime": "A String", # Optional. When this backup is automatically expired. "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. + "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId} "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for }, "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. @@ -597,6 +599,8 @@

Method Details

"expireTime": "A String", # Optional. When this backup is automatically expired. "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. + "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId} "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for }, "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. @@ -849,6 +853,8 @@

Method Details

"expireTime": "A String", # Optional. When this backup is automatically expired. "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource. "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. + "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId} "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for }, "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html index 60e7754c02..cbb7b833d0 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html @@ -267,6 +267,8 @@

Method Details

"backupPlan": "A String", # The name of the backup plan. "backupPlanAssociation": "A String", # The name of the backup plan association. "backupPlanDescription": "A String", # The description of the backup plan. + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc. + "backupPlanRevisionName": "A String", # The name of the backup plan revision. "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault "A String", ], @@ -390,6 +392,8 @@

Method Details

"backupPlan": "A String", # The name of the backup plan. "backupPlanAssociation": "A String", # The name of the backup plan association. "backupPlanDescription": "A String", # The description of the backup plan. + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc. + "backupPlanRevisionName": "A String", # The name of the backup plan revision. "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault "A String", ], @@ -493,6 +497,8 @@

Method Details

"backupPlan": "A String", # The name of the backup plan. "backupPlanAssociation": "A String", # The name of the backup plan association. "backupPlanDescription": "A String", # The description of the backup plan. + "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc. + "backupPlanRevisionName": "A String", # The name of the backup plan revision. "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault "A String", ], diff --git a/docs/dyn/beyondcorp_v1.organizations.locations.html b/docs/dyn/beyondcorp_v1.organizations.locations.html index dc239fcf19..eee55b4956 100644 --- a/docs/dyn/beyondcorp_v1.organizations.locations.html +++ b/docs/dyn/beyondcorp_v1.organizations.locations.html @@ -74,11 +74,6 @@

BeyondCorp API . organizations . locations

Instance Methods

-

- global_() -

-

Returns the global_ Resource.

-

operations()

diff --git a/docs/dyn/beyondcorp_v1.projects.locations.html b/docs/dyn/beyondcorp_v1.projects.locations.html index ef004b60db..ce43c0075e 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.html @@ -89,16 +89,6 @@

Instance Methods

Returns the appGateways Resource.

-

- clientConnectorServices() -

-

Returns the clientConnectorServices Resource.

- -

- clientGateways() -

-

Returns the clientGateways Resource.

-

global_()

diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html index 20cf594484..10c91e6020 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html @@ -124,7 +124,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Information about a BeyoncCorp SecurityGateway resource. +{ # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -226,7 +226,7 @@

Method Details

Returns: An object of the form: - { # Information about a BeyoncCorp SecurityGateway resource. + { # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -316,7 +316,7 @@

Method Details

{ # Message for response to listing SecurityGateways. "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list. "securityGateways": [ # A list of BeyondCorp SecurityGateway in the project. - { # Information about a BeyoncCorp SecurityGateway resource. + { # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -365,7 +365,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Information about a BeyoncCorp SecurityGateway resource. +{ # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. diff --git a/docs/dyn/beyondcorp_v1alpha.organizations.locations.global_.partnerTenants.html b/docs/dyn/beyondcorp_v1alpha.organizations.locations.global_.partnerTenants.html index bf4246b636..46970ba695 100644 --- a/docs/dyn/beyondcorp_v1alpha.organizations.locations.global_.partnerTenants.html +++ b/docs/dyn/beyondcorp_v1alpha.organizations.locations.global_.partnerTenants.html @@ -74,16 +74,6 @@

BeyondCorp API . organizations . locations . global_ . partnerTenants

Instance Methods

-

- browserDlpRules() -

-

Returns the browserDlpRules Resource.

- -

- proxyConfigs() -

-

Returns the proxyConfigs Resource.

-

close()

Close httplib2 connections.

@@ -99,9 +89,6 @@

Instance Methods

list_next()

Retrieves the next page of results.

-

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

-

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

Method Details

close() @@ -227,34 +214,4 @@

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/beyondcorp_v1alpha.projects.locations.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.html index 3004717011..caca10229c 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.html @@ -99,16 +99,6 @@

Instance Methods

Returns the applications Resource.

-

- clientConnectorServices() -

-

Returns the clientConnectorServices Resource.

- -

- clientGateways() -

-

Returns the clientGateways Resource.

-

connections()

diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 57eb2acce4..5879a7afee 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -124,7 +124,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Information about a BeyoncCorp SecurityGateway resource. +{ # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -226,7 +226,7 @@

Method Details

Returns: An object of the form: - { # Information about a BeyoncCorp SecurityGateway resource. + { # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -316,7 +316,7 @@

Method Details

{ # Message for response to listing SecurityGateways. "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list. "securityGateways": [ # A list of BeyondCorp SecurityGateway in the project. - { # Information about a BeyoncCorp SecurityGateway resource. + { # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. @@ -365,7 +365,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Information about a BeyoncCorp SecurityGateway resource. +{ # Information about a BeyondCorp SecurityGateway resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. "externalIps": [ # Output only. IP addresses that will be used for establishing connection to the endpoints. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html index 21d07ed5f3..cd840bd320 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html @@ -131,7 +131,7 @@

Method Details

"routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface. }, "workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool. - "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 2000. If `0` is specified, Cloud Build will use a standard disk size. + "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. }, }, @@ -244,7 +244,7 @@

Method Details

"routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface. }, "workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool. - "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 2000. If `0` is specified, Cloud Build will use a standard disk size. + "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. }, }, @@ -294,7 +294,7 @@

Method Details

"routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface. }, "workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool. - "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 2000. If `0` is specified, Cloud Build will use a standard disk size. + "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. }, }, @@ -350,7 +350,7 @@

Method Details

"routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface. }, "workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool. - "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 2000. If `0` is specified, Cloud Build will use a standard disk size. + "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. }, }, diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html index ff1dac7ce9..357cb109c2 100644 --- a/docs/dyn/cloudresourcemanager_v1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1.projects.html @@ -175,6 +175,9 @@

Method Details

The object takes the form of: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", @@ -254,6 +257,9 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", @@ -470,6 +476,9 @@

Method Details

"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. "projects": [ # The list of Projects that matched the list filter. This list can be paginated. { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", @@ -840,6 +849,9 @@

Method Details

The object takes the form of: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", @@ -866,6 +878,9 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html index b918bf6eea..e85f7c473a 100644 --- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html @@ -125,6 +125,9 @@

Method Details

The object takes the form of: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", @@ -149,6 +152,9 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", @@ -197,6 +203,9 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", @@ -320,6 +329,9 @@

Method Details

"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. "projects": [ # The list of Projects that matched the list filter. This list can be paginated. { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", @@ -500,6 +512,9 @@

Method Details

The object takes the form of: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", @@ -523,6 +538,9 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Creation time. Read-only. "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write. "a_key": "A String", diff --git a/docs/dyn/cloudresourcemanager_v3.locations.tagBindingCollections.html b/docs/dyn/cloudresourcemanager_v3.locations.tagBindingCollections.html index 7719f2e487..887f6f5a50 100644 --- a/docs/dyn/cloudresourcemanager_v3.locations.tagBindingCollections.html +++ b/docs/dyn/cloudresourcemanager_v3.locations.tagBindingCollections.html @@ -81,8 +81,8 @@

Instance Methods

get(name, x__xgafv=None)

Returns tag bindings directly attached to a GCP resource.

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

-

Updates tag bindings directly attached to a GCP resource. Update_mask can be kept empty or "*".

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

+

Updates tag bindings directly attached to a GCP resource.

Method Details

close() @@ -114,8 +114,8 @@

Method Details

- patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates tag bindings directly attached to a GCP resource. Update_mask can be kept empty or "*".
+    update(name, body=None, x__xgafv=None)
+  
Updates tag bindings directly attached to a GCP resource.
 
 Args:
   name: string, Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. "locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123" (required)
@@ -131,7 +131,6 @@ 

Method Details

}, } - updateMask: string, Optional. An update mask to selectively update fields. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudresourcemanager_v3.projects.html b/docs/dyn/cloudresourcemanager_v3.projects.html index 2471eeb62b..dc6df9ff51 100644 --- a/docs/dyn/cloudresourcemanager_v3.projects.html +++ b/docs/dyn/cloudresourcemanager_v3.projects.html @@ -131,6 +131,9 @@

Method Details

The object takes the form of: { # A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Output only. Creation time. "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. "displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` @@ -227,6 +230,9 @@

Method Details

An object of the form: { # A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Output only. Creation time. "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. "displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` @@ -322,6 +328,9 @@

Method Details

"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. "projects": [ # The list of Projects under the parent. This list can be paginated. { # A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Output only. Creation time. "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. "displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` @@ -408,6 +417,9 @@

Method Details

The object takes the form of: { # A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Output only. Creation time. "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. "displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` @@ -475,6 +487,9 @@

Method Details

"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. "projects": [ # The list of Projects that matched the list filter query. This list can be paginated. { # A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources. + "configuredCapabilities": [ # Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY. + "A String", + ], "createTime": "A String", # Output only. Creation time. "deleteTime": "A String", # Output only. The time at which this resource was requested for deletion. "displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html index dc7a9dd504..f485a78d6c 100644 --- a/docs/dyn/config_v1.projects.locations.previews.html +++ b/docs/dyn/config_v1.projects.locations.previews.html @@ -74,6 +74,16 @@

Infrastructure Manager API . projects . locations . previews

Instance Methods

+

+ resourceChanges() +

+

Returns the resourceChanges Resource.

+ +

+ resourceDrifts() +

+

Returns the resourceDrifts Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/config_v1.projects.locations.previews.resourceChanges.html b/docs/dyn/config_v1.projects.locations.previews.resourceChanges.html new file mode 100644 index 0000000000..35dfef3752 --- /dev/null +++ b/docs/dyn/config_v1.projects.locations.previews.resourceChanges.html @@ -0,0 +1,205 @@ + + + +

Infrastructure Manager API . projects . locations . previews . resourceChanges

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a ResourceChange for a given preview.

+

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

+

Lists ResourceChanges for a given preview.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a ResourceChange for a given preview.
+
+Args:
+  name: string, Required. The name of the resource change to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'. (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 change represents a change to a resource in the state file.
+  "intent": "A String", # Output only. The intent of the resource change.
+  "name": "A String", # Identifier. The name of the resource change. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.
+  "propertyChanges": [ # Output only. The property changes of the resource change.
+    { # A property change represents a change to a property in the state file.
+      "after": "", # Output only. Representations of the object value after the actions.
+      "afterSensitivePaths": [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
+        "A String",
+      ],
+      "before": "", # Output only. Representations of the object value before the actions.
+      "beforeSensitivePaths": [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
+        "A String",
+      ],
+      "path": "A String", # Output only. The path of the property change.
+    },
+  ],
+  "terraformInfo": { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource change.
+    "actions": [ # Output only. TF resource actions.
+      "A String",
+    ],
+    "address": "A String", # Output only. TF resource address that uniquely identifies the resource.
+    "provider": "A String", # Output only. TF resource provider.
+    "resourceName": "A String", # Output only. TF resource name.
+    "type": "A String", # Output only. TF resource type.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ResourceChanges for a given preview.
+
+Args:
+  parent: string, Required. The parent in whose context the ResourceChanges are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'. (required)
+  filter: string, Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/previews/dep/resourceChanges/baz
+  orderBy: string, Optional. Field to use to sort the list.
+  pageSize: integer, Optional. When requesting a page of resource changes, 'page_size' specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
+  pageToken: string, Optional. Token returned by previous call to 'ListResourceChanges' which specifies the position in the list from where to continue listing the resource changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response to a 'ListResourceChanges' call. Contains a list of ResourceChanges.
+  "nextPageToken": "A String", # A token to request the next page of resources from the 'ListResourceChanges' method. The value of an empty string means that there are no more resources to return.
+  "resourceChanges": [ # List of ResourceChanges.
+    { # A resource change represents a change to a resource in the state file.
+      "intent": "A String", # Output only. The intent of the resource change.
+      "name": "A String", # Identifier. The name of the resource change. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.
+      "propertyChanges": [ # Output only. The property changes of the resource change.
+        { # A property change represents a change to a property in the state file.
+          "after": "", # Output only. Representations of the object value after the actions.
+          "afterSensitivePaths": [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
+            "A String",
+          ],
+          "before": "", # Output only. Representations of the object value before the actions.
+          "beforeSensitivePaths": [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
+            "A String",
+          ],
+          "path": "A String", # Output only. The path of the property change.
+        },
+      ],
+      "terraformInfo": { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource change.
+        "actions": [ # Output only. TF resource actions.
+          "A String",
+        ],
+        "address": "A String", # Output only. TF resource address that uniquely identifies the resource.
+        "provider": "A String", # Output only. TF resource provider.
+        "resourceName": "A String", # Output only. TF resource name.
+        "type": "A String", # Output only. TF resource type.
+      },
+    },
+  ],
+  "unreachable": [ # Unreachable resources, if any.
+    "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/config_v1.projects.locations.previews.resourceDrifts.html b/docs/dyn/config_v1.projects.locations.previews.resourceDrifts.html new file mode 100644 index 0000000000..b8ee51660e --- /dev/null +++ b/docs/dyn/config_v1.projects.locations.previews.resourceDrifts.html @@ -0,0 +1,197 @@ + + + +

Infrastructure Manager API . projects . locations . previews . resourceDrifts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a ResourceDrift for a given preview.

+

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

+

List ResourceDrifts for a given preview.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a ResourceDrift for a given preview.
+
+Args:
+  name: string, Required. The name of the resource drift to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'. (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 drift represents a drift to a resource in the state file.
+  "name": "A String", # Identifier. The name of the resource drift. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.
+  "propertyDrifts": [ # Output only. The property drifts of the resource drift.
+    { # A property drift represents a drift to a property in the state file.
+      "after": "", # Output only. Representations of the object value after the actions.
+      "afterSensitivePaths": [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
+        "A String",
+      ],
+      "before": "", # Output only. Representations of the object value before the actions.
+      "beforeSensitivePaths": [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
+        "A String",
+      ],
+      "path": "A String", # Output only. The path of the property drift.
+    },
+  ],
+  "terraformInfo": { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource drift.
+    "address": "A String", # Output only. The address of the drifted resource.
+    "provider": "A String", # Output only. The provider of the drifted resource.
+    "resourceName": "A String", # Output only. TF resource name.
+    "type": "A String", # Output only. The type of the drifted resource.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List ResourceDrifts for a given preview.
+
+Args:
+  parent: string, Required. The parent in whose context the ResourceDrifts are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'. (required)
+  filter: string, Optional. Lists the resource drifts that match the filter expression. A filter expression filters the resource drifts listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/previews/dep/resourceDrifts/baz
+  orderBy: string, Optional. Field to use to sort the list.
+  pageSize: integer, Optional. When requesting a page of resource drifts, 'page_size' specifies number of resource drifts to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
+  pageToken: string, Optional. Token returned by previous call to 'ListResourceDrifts' which specifies the position in the list from where to continue listing the resource drifts.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response to a 'ListResourceDrifts' call. Contains a list of ResourceDrifts.
+  "nextPageToken": "A String", # A token to request the next page of resources from the 'ListResourceDrifts' method. The value of an empty string means that there are no more resources to return.
+  "resourceDrifts": [ # List of ResourceDrifts.
+    { # A resource drift represents a drift to a resource in the state file.
+      "name": "A String", # Identifier. The name of the resource drift. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.
+      "propertyDrifts": [ # Output only. The property drifts of the resource drift.
+        { # A property drift represents a drift to a property in the state file.
+          "after": "", # Output only. Representations of the object value after the actions.
+          "afterSensitivePaths": [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
+            "A String",
+          ],
+          "before": "", # Output only. Representations of the object value before the actions.
+          "beforeSensitivePaths": [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
+            "A String",
+          ],
+          "path": "A String", # Output only. The path of the property drift.
+        },
+      ],
+      "terraformInfo": { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource drift.
+        "address": "A String", # Output only. The address of the drifted resource.
+        "provider": "A String", # Output only. The provider of the drifted resource.
+        "resourceName": "A String", # Output only. TF resource name.
+        "type": "A String", # Output only. The type of the drifted resource.
+      },
+    },
+  ],
+  "unreachable": [ # Unreachable resources, if any.
+    "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/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index e2a3aa670b..c270ec5c44 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -95,7 +95,7 @@

Instance Methods

Completes master IP rotation.

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

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(name, clusterId=None, projectId=None, x__xgafv=None, zone=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -119,7 +119,7 @@

Instance Methods

Enables or disables the ABAC authorization mechanism on a cluster.

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

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

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

Sets the logging service for a specific cluster.

@@ -196,8 +196,8 @@

Method Details

{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -227,7 +227,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -257,13 +257,13 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
create(parent, body=None, x__xgafv=None) -
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
   parent: string, The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. (required)
@@ -271,7 +271,7 @@ 

Method Details

The object takes the form of: { # 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) + "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/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. "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. @@ -304,7 +304,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -330,6 +330,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -343,14 +344,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -360,7 +361,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -448,7 +449,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -487,16 +488,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -508,6 +520,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -534,8 +548,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -581,8 +595,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -618,7 +632,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -641,7 +655,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -649,17 +663,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -675,7 +689,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -687,7 +701,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -701,7 +715,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -713,7 +727,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -751,27 +765,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -781,7 +795,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -804,7 +818,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -874,7 +888,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -889,7 +903,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -956,10 +970,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -975,7 +989,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -987,7 +1001,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1001,7 +1015,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1013,7 +1027,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1051,27 +1065,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1081,7 +1095,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1104,7 +1118,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1135,11 +1149,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1185,7 +1199,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1221,7 +1235,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -1291,7 +1305,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -1313,11 +1327,11 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -1347,7 +1361,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1377,7 +1391,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1388,12 +1402,12 @@

Method Details

Args: name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`. (required) clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -1417,7 +1431,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1447,7 +1461,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1497,12 +1511,12 @@

Method Details

Args: name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`. (required) clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -1540,7 +1554,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -1566,6 +1580,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -1579,14 +1594,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -1596,7 +1611,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -1684,7 +1699,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1723,16 +1738,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -1744,6 +1770,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -1770,8 +1798,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -1817,8 +1845,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -1854,7 +1882,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -1877,7 +1905,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -1885,17 +1913,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1911,7 +1939,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1923,7 +1951,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1937,7 +1965,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1949,7 +1977,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1987,27 +2015,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2017,7 +2045,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2040,7 +2068,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2110,7 +2138,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2125,7 +2153,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2192,10 +2220,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2211,7 +2239,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2223,7 +2251,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2237,7 +2265,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2249,7 +2277,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2287,27 +2315,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2317,7 +2345,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2340,7 +2368,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2371,11 +2399,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -2421,7 +2449,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -2457,7 +2485,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -2527,7 +2555,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -2549,7 +2577,7 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2595,12 +2623,12 @@

Method Details

Args: parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -2640,7 +2668,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -2666,6 +2694,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -2679,14 +2708,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -2696,7 +2725,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -2784,7 +2813,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2823,16 +2852,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -2844,6 +2884,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -2870,8 +2912,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -2917,8 +2959,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -2954,7 +2996,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -2977,7 +3019,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -2985,17 +3027,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3011,7 +3053,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3023,7 +3065,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3037,7 +3079,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3049,7 +3091,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3087,27 +3129,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3117,7 +3159,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3140,7 +3182,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3210,7 +3252,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3225,7 +3267,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3292,10 +3334,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3311,7 +3353,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3323,7 +3365,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3337,7 +3379,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3349,7 +3391,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3387,27 +3429,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3417,7 +3459,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3440,7 +3482,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3471,11 +3513,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -3521,7 +3563,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -3557,7 +3599,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -3627,7 +3669,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -3649,7 +3691,7 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3700,7 +3742,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -3724,8 +3766,8 @@

Method Details

}, "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -3755,7 +3797,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -3785,7 +3827,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3802,8 +3844,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -3833,7 +3875,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -3863,13 +3905,13 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
setLocations(name, body=None, x__xgafv=None) -
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
 
 Args:
   name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)
@@ -3878,12 +3920,12 @@ 

Method Details

{ # SetLocationsRequest sets the locations of the cluster. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. "A String", ], "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -3913,7 +3955,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -3943,7 +3985,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3960,8 +4002,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -3991,7 +4033,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4021,7 +4063,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4065,8 +4107,8 @@

Method Details

}, }, "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). - "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. + "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). + "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. } x__xgafv: string, V1 error format. @@ -4096,7 +4138,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4126,7 +4168,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4143,7 +4185,7 @@

Method Details

"action": "A String", # Required. The exact form of action to be taken on the master auth. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. @@ -4151,10 +4193,10 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4184,7 +4226,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4214,7 +4256,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4231,8 +4273,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4262,7 +4304,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4292,7 +4334,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4312,8 +4354,8 @@

Method Details

"enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4343,7 +4385,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4373,7 +4415,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4390,11 +4432,11 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "resourceLabels": { # Required. The labels to set for that cluster. "a_key": "A String", }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4424,7 +4466,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4454,7 +4496,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4470,9 +4512,9 @@

Method Details

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4502,7 +4544,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4532,7 +4574,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4548,7 +4590,7 @@

Method Details

{ # UpdateClusterRequest updates the settings of a cluster. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. "podRangeInfo": [ # Output only. Information for additional pod range. @@ -4561,6 +4603,16 @@

Method Details

"A String", ], }, + "desiredAdditionalIpRangesConfig": { # DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs. # The desired config for additional subnetworks attached to the cluster. + "additionalIpRangesConfigs": [ # List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], + }, "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. "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. @@ -4593,7 +4645,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -4616,11 +4668,14 @@

Method Details

}, }, "desiredAnonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "desiredAuthenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # The desired authenticator groups config for the cluster. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true. }, + "desiredAutoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # AutoIpamConfig contains all information related to Auto IPAM + }, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. @@ -4630,14 +4685,14 @@

Method Details

"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED. }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -4647,7 +4702,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -4695,7 +4750,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -4792,7 +4847,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster. }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -4901,7 +4956,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -4985,6 +5040,20 @@

Method Details

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, "desiredStackType": "A String", # The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type. + "desiredUserManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The desired user managed keys config for the cluster. + "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. + "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + "etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + "etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + "gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + "serviceAccountSigningKeys": [ # The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + "serviceAccountVerificationKeys": [ # The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + }, "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -4997,6 +5066,9 @@

Method Details

], }, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrade. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -5008,7 +5080,7 @@

Method Details

"A String", ], }, - "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. + "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. @@ -5023,7 +5095,7 @@

Method Details

], }, }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5053,7 +5125,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5083,7 +5155,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5100,8 +5172,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5131,7 +5203,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5161,7 +5233,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 1d2e3f893b..c112dcab92 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -176,10 +176,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -195,7 +195,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -207,7 +207,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -221,7 +221,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -233,7 +233,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -271,27 +271,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -301,7 +301,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -324,7 +324,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -355,11 +355,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -405,7 +405,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -441,11 +441,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -475,7 +475,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -505,7 +505,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -517,12 +517,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -546,7 +546,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -576,7 +576,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -627,12 +627,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -662,10 +662,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -681,7 +681,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -693,7 +693,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -707,7 +707,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -719,7 +719,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -757,27 +757,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -787,7 +787,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -810,7 +810,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -841,11 +841,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -891,7 +891,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -927,7 +927,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). } @@ -938,12 +938,12 @@

Method Details

Args: parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -975,10 +975,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -994,7 +994,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1006,7 +1006,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1020,7 +1020,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1032,7 +1032,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1070,27 +1070,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1100,7 +1100,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1123,7 +1123,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1154,11 +1154,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1204,7 +1204,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1240,7 +1240,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], } @@ -1259,9 +1259,9 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1291,7 +1291,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1321,7 +1321,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1347,8 +1347,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1378,7 +1378,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1408,7 +1408,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1433,8 +1433,8 @@

Method Details

}, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1464,7 +1464,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1494,7 +1494,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1512,8 +1512,8 @@

Method Details

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeCount": 42, # Required. The desired node count for the pool. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1543,7 +1543,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1573,7 +1573,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1587,10 +1587,10 @@

Method Details

The object takes the form of: { # UpdateNodePoolRequests update a node pool's image and/or version. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1613,7 +1613,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1634,7 +1634,7 @@

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. }, - "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. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1673,7 +1673,7 @@

Method Details

"a_key": "A String", }, }, - "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1681,7 +1681,7 @@

Method Details

"variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. + "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "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/*`. "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -1715,16 +1715,16 @@

Method Details

}, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1765,7 +1765,7 @@

Method Details

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool. "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1795,7 +1795,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1825,7 +1825,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.html b/docs/dyn/container_v1.projects.locations.html index 73a9dee9d9..4c938ae1be 100644 --- a/docs/dyn/container_v1.projects.locations.html +++ b/docs/dyn/container_v1.projects.locations.html @@ -102,12 +102,12 @@

Method Details

Args: name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. Returns: An object of the form: diff --git a/docs/dyn/container_v1.projects.locations.operations.html b/docs/dyn/container_v1.projects.locations.operations.html index 6c0e4e223c..f81fb6ffef 100644 --- a/docs/dyn/container_v1.projects.locations.operations.html +++ b/docs/dyn/container_v1.projects.locations.operations.html @@ -99,8 +99,8 @@

Method Details

{ # CancelOperationRequest cancels a single operation. "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -127,12 +127,12 @@

Method Details

Args: name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required) operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -156,7 +156,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -186,7 +186,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -196,12 +196,12 @@

Method Details

Args: parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -230,7 +230,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -260,7 +260,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index a82e898351..5ca38bb118 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -90,7 +90,7 @@

Instance Methods

Completes master IP rotation.

create(projectId, zone, body=None, x__xgafv=None)

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(projectId, zone, clusterId, name=None, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -108,7 +108,7 @@

Instance Methods

Lists all clusters owned by a project in either the specified zone or all zones.

locations(projectId, zone, clusterId, body=None, x__xgafv=None)

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

logging(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the logging service for a specific cluster.

@@ -142,8 +142,8 @@

Method Details

Sets the addons for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -181,7 +181,7 @@ 

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -205,8 +205,8 @@

Method Details

}, "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -236,7 +236,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -266,7 +266,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -280,8 +280,8 @@

Method Details

Completes master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -289,8 +289,8 @@ 

Method Details

{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -320,7 +320,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -350,22 +350,22 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
create(projectId, zone, body=None, x__xgafv=None) -
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # 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)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/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.
       "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.
@@ -398,7 +398,7 @@ 

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -424,6 +424,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -437,14 +438,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -454,7 +455,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -542,7 +543,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -581,16 +582,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -602,6 +614,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -628,8 +642,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -675,8 +689,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -712,7 +726,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -735,7 +749,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -743,17 +757,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -769,7 +783,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -781,7 +795,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -795,7 +809,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -807,7 +821,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -845,27 +859,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -875,7 +889,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -898,7 +912,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -968,7 +982,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -983,7 +997,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1050,10 +1064,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1069,7 +1083,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1081,7 +1095,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1095,7 +1109,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1107,7 +1121,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1145,27 +1159,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1175,7 +1189,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1198,7 +1212,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1229,11 +1243,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1279,7 +1293,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1315,7 +1329,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -1385,7 +1399,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -1407,11 +1421,11 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -1441,7 +1455,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1471,7 +1485,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1480,8 +1494,8 @@

Method Details

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1511,7 +1525,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1541,7 +1555,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1589,8 +1603,8 @@

Method Details

Gets the details of a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1634,7 +1648,7 @@ 

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -1660,6 +1674,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -1673,14 +1688,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -1690,7 +1705,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -1778,7 +1793,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1817,16 +1832,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -1838,6 +1864,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -1864,8 +1892,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -1911,8 +1939,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -1948,7 +1976,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -1971,7 +1999,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -1979,17 +2007,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2005,7 +2033,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2017,7 +2045,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2031,7 +2059,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2043,7 +2071,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2081,27 +2109,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2111,7 +2139,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2134,7 +2162,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2204,7 +2232,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2219,7 +2247,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2286,10 +2314,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2305,7 +2333,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2317,7 +2345,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2331,7 +2359,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2343,7 +2371,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2381,27 +2409,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2411,7 +2439,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2434,7 +2462,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2465,11 +2493,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -2515,7 +2543,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -2551,7 +2579,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -2621,7 +2649,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -2643,7 +2671,7 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }
@@ -2652,8 +2680,8 @@

Method Details

Enables or disables the ABAC authorization mechanism on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -2662,8 +2690,8 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -2693,7 +2721,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -2723,7 +2751,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -2732,8 +2760,8 @@

Method Details

Lists all clusters owned by a project in either the specified zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -2778,7 +2806,7 @@ 

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -2804,6 +2832,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -2817,14 +2846,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -2834,7 +2863,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -2922,7 +2951,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2961,16 +2990,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -2982,6 +3022,8 @@

Method Details

"A String", ], }, + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. @@ -3008,8 +3050,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -3055,8 +3097,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. @@ -3092,7 +3134,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -3115,7 +3157,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster. }, @@ -3123,17 +3165,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3149,7 +3191,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3161,7 +3203,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3175,7 +3217,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3187,7 +3229,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3225,27 +3267,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3255,7 +3297,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3278,7 +3320,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3348,7 +3390,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3363,7 +3405,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3430,10 +3472,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3449,7 +3491,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3461,7 +3503,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3475,7 +3517,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3487,7 +3529,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3525,27 +3567,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3555,7 +3597,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3578,7 +3620,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3609,11 +3651,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -3659,7 +3701,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -3695,7 +3737,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -3765,7 +3807,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. @@ -3787,7 +3829,7 @@

Method Details

"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3798,23 +3840,23 @@

Method Details

locations(projectId, zone, clusterId, body=None, x__xgafv=None) -
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLocationsRequest sets the locations of the cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -3844,7 +3886,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -3874,7 +3916,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3883,8 +3925,8 @@

Method Details

Sets the logging service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -3893,8 +3935,8 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -3924,7 +3966,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -3954,7 +3996,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3963,8 +4005,8 @@

Method Details

Updates the master for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -3973,8 +4015,8 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4004,7 +4046,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4034,7 +4076,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4043,8 +4085,8 @@

Method Details

Sets the monitoring service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4053,8 +4095,8 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4084,7 +4126,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4114,7 +4156,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4123,8 +4165,8 @@

Method Details

Sets labels on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4133,11 +4175,11 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "resourceLabels": { # Required. The labels to set for that cluster. "a_key": "A String", }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4167,7 +4209,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4197,7 +4239,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4206,8 +4248,8 @@

Method Details

Sets the maintenance policy for a cluster.
 
 Args:
-  projectId: string, Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). (required)
-  zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)
+  projectId: string, Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). (required)
+  zone: string, Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. (required)
   clusterId: string, Required. The name of the cluster to update. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4243,8 +4285,8 @@ 

Method Details

}, }, "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). - "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. + "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). + "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. } x__xgafv: string, V1 error format. @@ -4274,7 +4316,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4304,7 +4346,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4313,8 +4355,8 @@

Method Details

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4323,7 +4365,7 @@ 

Method Details

"action": "A String", # Required. The exact form of action to be taken on the master auth. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. @@ -4331,10 +4373,10 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4364,7 +4406,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4394,7 +4436,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4403,8 +4445,8 @@

Method Details

Enables or disables Network Policy for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4416,8 +4458,8 @@ 

Method Details

"enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4447,7 +4489,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4477,7 +4519,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4486,8 +4528,8 @@

Method Details

Starts master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4495,9 +4537,9 @@ 

Method Details

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4527,7 +4569,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4557,7 +4599,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4566,8 +4608,8 @@

Method Details

Updates the settings of a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4575,7 +4617,7 @@ 

Method Details

{ # UpdateClusterRequest updates the settings of a cluster. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. "podRangeInfo": [ # Output only. Information for additional pod range. @@ -4588,6 +4630,16 @@

Method Details

"A String", ], }, + "desiredAdditionalIpRangesConfig": { # DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs. # The desired config for additional subnetworks attached to the cluster. + "additionalIpRangesConfigs": [ # List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], + }, "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. "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. @@ -4620,7 +4672,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -4643,11 +4695,14 @@

Method Details

}, }, "desiredAnonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "desiredAuthenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # The desired authenticator groups config for the cluster. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true. }, + "desiredAutoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # AutoIpamConfig contains all information related to Auto IPAM + }, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. @@ -4657,14 +4712,14 @@

Method Details

"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED. }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "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. @@ -4674,7 +4729,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -4722,7 +4777,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -4819,7 +4874,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster. }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -4928,7 +4983,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -5012,6 +5067,20 @@

Method Details

"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, "desiredStackType": "A String", # The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type. + "desiredUserManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The desired user managed keys config for the cluster. + "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. + "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + "etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + "etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + "gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + "serviceAccountSigningKeys": [ # The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + "serviceAccountVerificationKeys": [ # The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + }, "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -5024,6 +5093,9 @@

Method Details

], }, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrade. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -5035,7 +5107,7 @@

Method Details

"A String", ], }, - "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. + "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. @@ -5050,7 +5122,7 @@

Method Details

], }, }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5080,7 +5152,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5110,7 +5182,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index ca07818253..25fa8aa7a8 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -113,8 +113,8 @@

Method Details

Sets the autoscaling settings for the specified node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -133,8 +133,8 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -164,7 +164,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -194,7 +194,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -208,8 +208,8 @@

Method Details

Creates a node pool for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -241,10 +241,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -260,7 +260,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -272,7 +272,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -286,7 +286,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -298,7 +298,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -336,27 +336,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -366,7 +366,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -389,7 +389,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -420,11 +420,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -470,7 +470,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -506,11 +506,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -540,7 +540,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -570,7 +570,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -579,8 +579,8 @@

Method Details

Deletes a node pool from a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -611,7 +611,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -641,7 +641,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -689,8 +689,8 @@

Method Details

Retrieves the requested node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -727,10 +727,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -746,7 +746,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -758,7 +758,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -772,7 +772,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -784,7 +784,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -822,27 +822,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -852,7 +852,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -875,7 +875,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -906,11 +906,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -956,7 +956,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -992,7 +992,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }
@@ -1001,8 +1001,8 @@

Method Details

Lists the node pools for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1040,10 +1040,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1059,7 +1059,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1071,7 +1071,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1085,7 +1085,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1097,7 +1097,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1135,27 +1135,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1165,7 +1165,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1188,7 +1188,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1219,11 +1219,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1269,7 +1269,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1305,7 +1305,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], }
@@ -1316,8 +1316,8 @@

Method Details

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1327,9 +1327,9 @@ 

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1359,7 +1359,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1389,7 +1389,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1398,8 +1398,8 @@

Method Details

Sets the NodeManagement options for a node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1417,8 +1417,8 @@ 

Method Details

}, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1448,7 +1448,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1478,7 +1478,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1487,8 +1487,8 @@

Method Details

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1499,8 +1499,8 @@ 

Method Details

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeCount": 42, # Required. The desired node count for the pool. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1530,7 +1530,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1560,7 +1560,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1569,18 +1569,18 @@

Method Details

Updates the version and/or image type for the specified node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # UpdateNodePoolRequests update a node pool's image and/or version.
-  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
+  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
     { # AcceleratorConfig represents a Hardware Accelerator request.
       "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
+      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
       "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
         "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
       },
@@ -1603,7 +1603,7 @@ 

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1624,7 +1624,7 @@

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. }, - "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. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1663,7 +1663,7 @@

Method Details

"a_key": "A String", }, }, - "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1671,7 +1671,7 @@

Method Details

"variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. + "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "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/*`. "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -1705,16 +1705,16 @@

Method Details

}, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1755,7 +1755,7 @@

Method Details

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool. "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1785,7 +1785,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1815,7 +1815,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
diff --git a/docs/dyn/container_v1.projects.zones.html b/docs/dyn/container_v1.projects.zones.html index ad1a4a8d63..a478ee8e5e 100644 --- a/docs/dyn/container_v1.projects.zones.html +++ b/docs/dyn/container_v1.projects.zones.html @@ -101,8 +101,8 @@

Method Details

Returns configuration info about the Google Kubernetes Engine service.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/container_v1.projects.zones.operations.html b/docs/dyn/container_v1.projects.zones.operations.html
index ba1fa70d5f..44eae50b59 100644
--- a/docs/dyn/container_v1.projects.zones.operations.html
+++ b/docs/dyn/container_v1.projects.zones.operations.html
@@ -92,8 +92,8 @@ 

Method Details

Cancels the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -101,8 +101,8 @@ 

Method Details

{ # CancelOperationRequest cancels a single operation. "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -127,8 +127,8 @@

Method Details

Gets the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.
   x__xgafv: string, V1 error format.
@@ -158,7 +158,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -188,7 +188,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -197,8 +197,8 @@

Method Details

Lists all operations in a project in a specific zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -232,7 +232,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -262,7 +262,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], }
diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index c7e932bc94..f0e229d2c3 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -95,7 +95,7 @@

Instance Methods

Completes master IP rotation.

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

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(name, clusterId=None, projectId=None, x__xgafv=None, zone=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -119,7 +119,7 @@

Instance Methods

Enables or disables the ABAC authorization mechanism on a cluster.

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

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

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

Sets the logging service for a specific cluster.

@@ -194,10 +194,10 @@

Method Details

The object takes the form of: { # CompleteIPRotationRequest moves the cluster master back into single-IP mode. - "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -227,7 +227,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -257,13 +257,13 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
create(parent, body=None, x__xgafv=None) -
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
   parent: string, The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. (required)
@@ -271,7 +271,7 @@ 

Method Details

The object takes the form of: { # CreateClusterRequest creates a cluster. - "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters) + "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/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. "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. @@ -311,7 +311,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -337,6 +337,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -353,14 +354,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -370,8 +371,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -468,7 +469,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -507,16 +508,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -529,6 +541,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -555,8 +569,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -604,8 +618,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -642,7 +656,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -665,7 +679,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -673,17 +687,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -700,7 +714,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -712,7 +726,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -725,11 +739,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -749,7 +763,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -787,27 +801,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -817,7 +831,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -841,7 +855,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -912,7 +926,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -927,7 +941,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1002,10 +1016,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1022,7 +1036,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1034,7 +1048,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1047,11 +1061,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1071,7 +1085,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1109,27 +1123,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1139,7 +1153,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1163,7 +1177,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1195,11 +1209,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1246,7 +1260,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1284,7 +1298,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -1368,7 +1382,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -1403,11 +1417,11 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -1437,7 +1451,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1467,7 +1481,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1477,13 +1491,13 @@

Method Details

Args: name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`. (required) - clusterId: string, Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -1507,7 +1521,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1537,7 +1551,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1586,13 +1600,13 @@

Method Details

Args: name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`. (required) - clusterId: string, Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -1637,7 +1651,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -1663,6 +1677,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -1679,14 +1694,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -1696,8 +1711,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -1794,7 +1809,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1833,16 +1848,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -1855,6 +1881,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -1881,8 +1909,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -1930,8 +1958,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -1968,7 +1996,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -1991,7 +2019,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1999,17 +2027,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2026,7 +2054,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2038,7 +2066,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2051,11 +2079,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2075,7 +2103,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2113,27 +2141,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2143,7 +2171,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2167,7 +2195,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2238,7 +2266,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2253,7 +2281,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2328,10 +2356,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2348,7 +2376,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2360,7 +2388,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2373,11 +2401,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2397,7 +2425,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2435,27 +2463,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2465,7 +2493,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2489,7 +2517,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2521,11 +2549,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -2572,7 +2600,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -2610,7 +2638,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -2694,7 +2722,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -2729,7 +2757,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }
@@ -2775,12 +2803,12 @@

Method Details

Args: parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -2827,7 +2855,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -2853,6 +2881,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -2869,14 +2898,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -2886,8 +2915,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -2984,7 +3013,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -3023,16 +3052,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -3045,6 +3085,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -3071,8 +3113,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -3120,8 +3162,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -3158,7 +3200,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -3181,7 +3223,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3189,17 +3231,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3216,7 +3258,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3228,7 +3270,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3241,11 +3283,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3265,7 +3307,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3303,27 +3345,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3333,7 +3375,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3357,7 +3399,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3428,7 +3470,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3443,7 +3485,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3518,10 +3560,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3538,7 +3580,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3550,7 +3592,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3563,11 +3605,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3587,7 +3629,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3625,27 +3667,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3655,7 +3697,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3679,7 +3721,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3711,11 +3753,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -3762,7 +3804,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -3800,7 +3842,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -3884,7 +3926,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -3919,7 +3961,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3977,7 +4019,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -3999,10 +4041,10 @@

Method Details

"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, }, - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4032,7 +4074,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4062,7 +4104,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4076,11 +4118,11 @@

Method Details

The object takes the form of: { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4110,7 +4152,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4140,13 +4182,13 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
setLocations(name, body=None, x__xgafv=None) -
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
 
 Args:
   name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)
@@ -4154,13 +4196,13 @@ 

Method Details

The object takes the form of: { # SetLocationsRequest sets the locations of the cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. - "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. "A String", ], "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4190,7 +4232,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4220,7 +4262,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4234,11 +4276,11 @@

Method Details

The object takes the form of: { # SetLoggingServiceRequest sets the logging service of a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4268,7 +4310,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4298,7 +4340,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4342,8 +4384,8 @@

Method Details

}, }, "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). - "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. + "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). + "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. } x__xgafv: string, V1 error format. @@ -4373,7 +4415,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4403,7 +4445,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4418,9 +4460,9 @@

Method Details

{ # SetMasterAuthRequest updates the admin password of a cluster. "action": "A String", # Required. The exact form of action to be taken on the master auth. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. @@ -4428,10 +4470,10 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4461,7 +4503,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4491,7 +4533,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4505,11 +4547,11 @@

Method Details

The object takes the form of: { # SetMonitoringServiceRequest sets the monitoring service of a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4539,7 +4581,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4569,7 +4611,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4583,14 +4625,14 @@

Method Details

The object takes the form of: { # SetNetworkPolicyRequest enables/disables network policy for a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`. "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4620,7 +4662,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4650,7 +4692,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4664,14 +4706,14 @@

Method Details

The object takes the form of: { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster - "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "resourceLabels": { # Required. The labels to set for that cluster. "a_key": "A String", }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4701,7 +4743,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4731,7 +4773,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4745,11 +4787,11 @@

Method Details

The object takes the form of: { # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. - "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4779,7 +4821,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4809,7 +4851,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4823,9 +4865,9 @@

Method Details

The object takes the form of: { # UpdateClusterRequest updates the settings of a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. "podRangeInfo": [ # Output only. Information for additional pod range. @@ -4838,6 +4880,16 @@

Method Details

"A String", ], }, + "desiredAdditionalIpRangesConfig": { # DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs. # The desired config for additional subnetworks attached to the cluster. + "additionalIpRangesConfigs": [ # List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], + }, "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. "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. @@ -4877,7 +4929,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -4900,11 +4952,14 @@

Method Details

}, }, "desiredAnonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "desiredAuthenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # AuthenticatorGroupsConfig specifies the config for the cluster security groups settings. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true. }, + "desiredAutoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # AutoIpamConfig contains all information related to Auto IPAM + }, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. @@ -4919,14 +4974,14 @@

Method Details

], }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -4936,8 +4991,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -4989,7 +5044,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -5094,7 +5149,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -5205,7 +5260,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -5307,6 +5362,20 @@

Method Details

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, + "desiredUserManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The desired user managed keys config for the cluster. + "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. + "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + "etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + "etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + "gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + "serviceAccountSigningKeys": [ # The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + "serviceAccountVerificationKeys": [ # The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + }, "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -5327,6 +5396,9 @@

Method Details

], }, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrade. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "privateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. Has no effect. Use desired_private_cluster_config instead. "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. Deprecated: Use NetworkConfig.default_enable_private_nodes instead. @@ -5350,7 +5422,7 @@

Method Details

"A String", ], }, - "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. + "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. @@ -5365,7 +5437,7 @@

Method Details

], }, }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5395,7 +5467,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5425,7 +5497,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5439,11 +5511,11 @@

Method Details

The object takes the form of: { # UpdateMasterRequest updates the master of the cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5473,7 +5545,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5503,7 +5575,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 8b949d17f4..f637638b25 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -150,7 +150,7 @@

Method Details

The object takes the form of: { # CreateNodePoolRequest creates a node pool for a cluster. - "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. @@ -176,10 +176,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -196,7 +196,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -208,7 +208,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -221,11 +221,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -245,7 +245,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -283,27 +283,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -313,7 +313,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -337,7 +337,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -369,11 +369,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -420,7 +420,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -458,11 +458,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -492,7 +492,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -522,7 +522,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -532,14 +532,14 @@

Method Details

Args: name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) - clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - nodePoolId: string, Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -563,7 +563,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -593,7 +593,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -642,14 +642,14 @@

Method Details

Args: name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) - clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. - nodePoolId: string, Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. + nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -679,10 +679,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -699,7 +699,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -711,7 +711,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -724,11 +724,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -748,7 +748,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -786,27 +786,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -816,7 +816,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -840,7 +840,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -872,11 +872,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -923,7 +923,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -961,7 +961,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). } @@ -971,13 +971,13 @@

Method Details

Args: parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`. (required) - clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -1009,10 +1009,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1029,7 +1029,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1041,7 +1041,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1054,11 +1054,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1078,7 +1078,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1116,27 +1116,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1146,7 +1146,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1170,7 +1170,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1202,11 +1202,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1253,7 +1253,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1291,7 +1291,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], } @@ -1307,12 +1307,12 @@

Method Details

The object takes the form of: { # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1342,7 +1342,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1372,7 +1372,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1395,11 +1395,11 @@

Method Details

"totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1429,7 +1429,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1459,7 +1459,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1473,7 +1473,7 @@

Method Details

The object takes the form of: { # SetNodePoolManagementRequest sets the node management properties of a node pool. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Required. NodeManagement configuration for the node pool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1483,9 +1483,9 @@

Method Details

}, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1515,7 +1515,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1545,7 +1545,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1559,12 +1559,12 @@

Method Details

The object takes the form of: { # SetNodePoolSizeRequest sets the size of a node pool. - "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeCount": 42, # Required. The desired node count for the pool. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1594,7 +1594,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1624,7 +1624,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1638,10 +1638,10 @@

Method Details

The object takes the form of: { # SetNodePoolVersionRequest updates the version of a node pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1653,7 +1653,7 @@

Method Details

"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU. }, ], - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1665,7 +1665,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1686,7 +1686,7 @@

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. }, - "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. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1725,7 +1725,7 @@

Method Details

"a_key": "A String", }, }, - "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1766,18 +1766,18 @@

Method Details

"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1821,7 +1821,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1851,7 +1851,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1881,7 +1881,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.html b/docs/dyn/container_v1beta1.projects.locations.html index 6fdff4e6be..3ca5d952d8 100644 --- a/docs/dyn/container_v1beta1.projects.locations.html +++ b/docs/dyn/container_v1beta1.projects.locations.html @@ -105,12 +105,12 @@

Method Details

Args: name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. (required) - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. Returns: An object of the form: diff --git a/docs/dyn/container_v1beta1.projects.locations.operations.html b/docs/dyn/container_v1beta1.projects.locations.operations.html index 3aff4a4731..7112eaafe6 100644 --- a/docs/dyn/container_v1beta1.projects.locations.operations.html +++ b/docs/dyn/container_v1beta1.projects.locations.operations.html @@ -98,9 +98,9 @@

Method Details

{ # CancelOperationRequest cancels a single operation. "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. - "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -126,13 +126,13 @@

Method Details

Args: name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required) - operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -156,7 +156,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -186,7 +186,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -196,12 +196,12 @@

Method Details

Args: parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -230,7 +230,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -260,7 +260,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index db028ae656..b7486bdf74 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -90,7 +90,7 @@

Instance Methods

Completes master IP rotation.

create(projectId, zone, body=None, x__xgafv=None)

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(projectId, zone, clusterId, name=None, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -108,7 +108,7 @@

Instance Methods

Lists all clusters owned by a project in either the specified zone or all zones.

locations(projectId, zone, clusterId, body=None, x__xgafv=None)

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

logging(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the logging service for a specific cluster.

@@ -142,9 +142,9 @@

Method Details

Sets the addons for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -188,7 +188,7 @@ 

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -210,10 +210,10 @@

Method Details

"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster. }, }, - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -243,7 +243,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -273,7 +273,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -287,17 +287,17 @@

Method Details

Completes master IP rotation.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -327,7 +327,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -357,22 +357,22 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
create(projectId, zone, body=None, x__xgafv=None) -
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CreateClusterRequest creates a cluster.
-  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/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.
       "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
         "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
@@ -412,7 +412,7 @@ 

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -438,6 +438,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -454,14 +455,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -471,8 +472,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -569,7 +570,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -608,16 +609,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -630,6 +642,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -656,8 +670,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -705,8 +719,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -743,7 +757,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -766,7 +780,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -774,17 +788,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -801,7 +815,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -813,7 +827,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -826,11 +840,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -850,7 +864,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -888,27 +902,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -918,7 +932,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -942,7 +956,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1013,7 +1027,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1028,7 +1042,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1103,10 +1117,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1123,7 +1137,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1135,7 +1149,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1148,11 +1162,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1172,7 +1186,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1210,27 +1224,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1240,7 +1254,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1264,7 +1278,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1296,11 +1310,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1347,7 +1361,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1385,7 +1399,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -1469,7 +1483,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -1504,11 +1518,11 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -1538,7 +1552,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1568,7 +1582,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1577,9 +1591,9 @@

Method Details

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1608,7 +1622,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1638,7 +1652,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1686,9 +1700,9 @@

Method Details

Gets the details for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1738,7 +1752,7 @@ 

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -1764,6 +1778,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -1780,14 +1795,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -1797,8 +1812,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -1895,7 +1910,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1934,16 +1949,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -1956,6 +1982,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -1982,8 +2010,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -2031,8 +2059,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -2069,7 +2097,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -2092,7 +2120,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -2100,17 +2128,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2127,7 +2155,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2139,7 +2167,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2152,11 +2180,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2176,7 +2204,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2214,27 +2242,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2244,7 +2272,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2268,7 +2296,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2339,7 +2367,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2354,7 +2382,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2429,10 +2457,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -2449,7 +2477,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -2461,7 +2489,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -2474,11 +2502,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -2498,7 +2526,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -2536,27 +2564,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -2566,7 +2594,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -2590,7 +2618,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -2622,11 +2650,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -2673,7 +2701,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -2711,7 +2739,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -2795,7 +2823,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -2830,7 +2858,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }
@@ -2839,18 +2867,18 @@

Method Details

Enables or disables the ABAC authorization mechanism on a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -2880,7 +2908,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -2910,7 +2938,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -2919,8 +2947,8 @@

Method Details

Lists all clusters owned by a project in either the specified zone or all zones.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -2972,7 +3000,7 @@ 

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -2998,6 +3026,7 @@

Method Details

"A String", ], "anonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. @@ -3014,14 +3043,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -3031,8 +3060,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -3129,7 +3158,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -3168,16 +3197,27 @@

Method Details

"preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrades. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "id": "A String", # Output only. Unique id for the cluster. "identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component. "enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") 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. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. + "additionalIpRangesConfigs": [ # Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy. + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. @@ -3190,6 +3230,8 @@

Method Details

], }, "allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified. + "autoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # Optional. AutoIpamConfig contains all information related to Auto IPAM + }, "clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block. "clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. @@ -3216,8 +3258,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -3265,8 +3307,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -3303,7 +3345,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "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. + "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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. "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 @@ -3326,7 +3368,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3334,17 +3376,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3361,7 +3403,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3373,7 +3415,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3386,11 +3428,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3410,7 +3452,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3448,27 +3490,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3478,7 +3520,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3502,7 +3544,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3573,7 +3615,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3588,7 +3630,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3663,10 +3705,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3683,7 +3725,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3695,7 +3737,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3708,11 +3750,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3732,7 +3774,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -3770,27 +3812,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3800,7 +3842,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3824,7 +3866,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3856,11 +3898,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -3907,7 +3949,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -3945,7 +3987,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -4029,7 +4071,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -4064,7 +4106,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -4075,23 +4117,23 @@

Method Details

locations(projectId, zone, clusterId, body=None, x__xgafv=None) -
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLocationsRequest sets the locations of the cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4121,7 +4163,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4151,7 +4193,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4160,18 +4202,18 @@

Method Details

Sets the logging service for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLoggingServiceRequest sets the logging service of a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4201,7 +4243,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4231,7 +4273,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4240,18 +4282,18 @@

Method Details

Updates the master for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # UpdateMasterRequest updates the master of the cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4281,7 +4323,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4311,7 +4353,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4320,18 +4362,18 @@

Method Details

Sets the monitoring service for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetMonitoringServiceRequest sets the monitoring service of a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4361,7 +4403,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4391,7 +4433,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4400,21 +4442,21 @@

Method Details

Sets labels on a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "resourceLabels": { # Required. The labels to set for that cluster.
     "a_key": "A String",
   },
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4444,7 +4486,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4474,7 +4516,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4483,8 +4525,8 @@

Method Details

Sets the maintenance policy for a cluster.
 
 Args:
-  projectId: string, Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). (required)
-  zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)
+  projectId: string, Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). (required)
+  zone: string, Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. (required)
   clusterId: string, Required. The name of the cluster to update. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4520,8 +4562,8 @@ 

Method Details

}, }, "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). - "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. + "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). + "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. } x__xgafv: string, V1 error format. @@ -4551,7 +4593,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4581,7 +4623,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4590,17 +4632,17 @@

Method Details

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetMasterAuthRequest updates the admin password of a cluster.
   "action": "A String", # Required. The exact form of action to be taken on the master auth.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
     "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
     "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
@@ -4608,10 +4650,10 @@ 

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4641,7 +4683,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4671,7 +4713,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4680,21 +4722,21 @@

Method Details

Enables or disables Network Policy for a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetNetworkPolicyRequest enables/disables network policy for a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.
   "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.
     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4724,7 +4766,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4754,7 +4796,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4763,18 +4805,18 @@

Method Details

Starts master IP rotation.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4804,7 +4846,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4834,7 +4876,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4843,16 +4885,16 @@

Method Details

Updates the settings for a specific cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # UpdateClusterRequest updates the settings of a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update.
     "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
       "podRangeInfo": [ # Output only. Information for additional pod range.
@@ -4865,6 +4907,16 @@ 

Method Details

"A String", ], }, + "desiredAdditionalIpRangesConfig": { # DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs. # The desired config for additional subnetworks attached to the cluster. + "additionalIpRangesConfigs": [ # List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges + { # AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster + "podIpv4RangeNames": [ # List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2 + "A String", + ], + "subnetwork": "A String", # Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet + }, + ], + }, "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. "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. @@ -4904,7 +4956,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "networkPolicyConfig": { # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. # Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. @@ -4927,11 +4979,14 @@

Method Details

}, }, "desiredAnonymousAuthenticationConfig": { # AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication. # Configuration for limiting anonymous access to all endpoints except the health checks. + "mode": "A String", # Defines the mode of limiting anonymous access in the cluster. }, "desiredAuthenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # AuthenticatorGroupsConfig specifies the config for the cluster security groups settings. "enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups. "securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true. }, + "desiredAutoIpamConfig": { # AutoIpamConfig contains all information related to Auto IPAM # AutoIpamConfig contains all information related to Auto IPAM + }, "desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration related to GCW workload policy # WorkloadPolicyConfig is the configuration related to GCW workload policy "allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability. "autopilotCompatibilityAuditingEnabled": True or False, # If true, enables the GCW Auditor that audits workloads on standard clusters. @@ -4946,14 +5001,14 @@

Method Details

], }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "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. @@ -4963,8 +5018,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -5016,7 +5071,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -5121,7 +5176,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -5232,7 +5287,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -5334,6 +5389,20 @@

Method Details

"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, + "desiredUserManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The desired user managed keys config for the cluster. + "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. + "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + "etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + "etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + "gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + "serviceAccountSigningKeys": [ # The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + "serviceAccountVerificationKeys": [ # The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}` + "A String", + ], + }, "desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -5354,6 +5423,9 @@

Method Details

], }, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. + "gkeAutoUpgradeConfig": { # GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. # Configuration for GKE auto upgrade. + "patchMode": "A String", # PatchMode specifies how auto upgrade patch builds should be selected. + }, "privateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. Has no effect. Use desired_private_cluster_config instead. "enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. Deprecated: Use NetworkConfig.default_enable_private_nodes instead. @@ -5377,7 +5449,7 @@

Method Details

"A String", ], }, - "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. + "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead. "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster. "clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster. "controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. @@ -5392,7 +5464,7 @@

Method Details

], }, }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5422,7 +5494,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5452,7 +5524,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 17bff9ac2a..846c2987b2 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -113,10 +113,10 @@

Method Details

Sets the autoscaling settings of a specific node pool.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -130,11 +130,11 @@ 

Method Details

"totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -164,7 +164,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -194,7 +194,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -208,14 +208,14 @@

Method Details

Creates a node pool for a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CreateNodePoolRequest creates a node pool for a cluster.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
+  "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
   "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create.
     "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler.
       "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes.
@@ -241,10 +241,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -261,7 +261,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -273,7 +273,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -286,11 +286,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -310,7 +310,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -348,27 +348,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -378,7 +378,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -402,7 +402,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -434,11 +434,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -485,7 +485,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -523,11 +523,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -557,7 +557,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -587,7 +587,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -596,10 +596,10 @@

Method Details

Deletes a node pool from a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -628,7 +628,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -658,7 +658,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -706,10 +706,10 @@

Method Details

Retrieves the requested node pool.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -744,10 +744,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -764,7 +764,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -776,7 +776,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -789,11 +789,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -813,7 +813,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -851,27 +851,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -881,7 +881,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -905,7 +905,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -937,11 +937,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -988,7 +988,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1026,7 +1026,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }
@@ -1035,9 +1035,9 @@

Method Details

Lists the node pools for a cluster.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1074,10 +1074,10 @@ 

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1094,7 +1094,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1106,7 +1106,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1119,11 +1119,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1143,7 +1143,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1181,27 +1181,27 @@

Method Details

}, }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "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). - "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "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://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). + "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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1211,7 +1211,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1235,7 +1235,7 @@

Method Details

}, "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1267,11 +1267,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "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. + "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1318,7 +1318,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1356,7 +1356,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). }, ], }
@@ -1367,20 +1367,20 @@

Method Details

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
-  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1410,7 +1410,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1440,7 +1440,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1449,15 +1449,15 @@

Method Details

Sets the NodeManagement options for a node pool.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetNodePoolManagementRequest sets the node management properties of a node pool.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Required. NodeManagement configuration for the node pool.
     "autoRepair": True or False, # Whether the nodes will be automatically repaired.
     "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1467,9 +1467,9 @@ 

Method Details

}, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1499,7 +1499,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1529,7 +1529,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1538,20 +1538,20 @@

Method Details

SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetNodePoolSizeRequest sets the size of a node pool.
-  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
+  "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodeCount": 42, # Required. The desired node count for the pool.
-  "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1581,7 +1581,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1611,7 +1611,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1620,18 +1620,18 @@

Method Details

Updates the version and/or image type of a specific node pool.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
-  nodePoolId: string, Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
+  nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetNodePoolVersionRequest updates the version of a node pool.
-  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
+  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
     { # AcceleratorConfig represents a Hardware Accelerator request.
       "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
+      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
       "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
         "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
       },
@@ -1643,7 +1643,7 @@ 

Method Details

"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU. }, ], - "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. + "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1655,7 +1655,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1676,7 +1676,7 @@

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. }, - "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. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/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. "A String", @@ -1715,7 +1715,7 @@

Method Details

"a_key": "A String", }, }, - "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1756,18 +1756,18 @@

Method Details

"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, - "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. + "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1811,7 +1811,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, - "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1841,7 +1841,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1871,7 +1871,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
diff --git a/docs/dyn/container_v1beta1.projects.zones.html b/docs/dyn/container_v1beta1.projects.zones.html index 1edf64bfa2..0df3a3569a 100644 --- a/docs/dyn/container_v1beta1.projects.zones.html +++ b/docs/dyn/container_v1beta1.projects.zones.html @@ -101,8 +101,8 @@

Method Details

Returns configuration info about the Google Kubernetes Engine service.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html
index 15b6c861ab..69cf14907a 100644
--- a/docs/dyn/container_v1beta1.projects.zones.operations.html
+++ b/docs/dyn/container_v1beta1.projects.zones.operations.html
@@ -92,17 +92,17 @@ 

Method Details

Cancels the specified operation.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
-  operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
+  operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CancelOperationRequest cancels a single operation.
   "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
-  "operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
+  "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -127,9 +127,9 @@ 

Method Details

Gets the specified operation.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
-  operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -158,7 +158,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -188,7 +188,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -197,8 +197,8 @@

Method Details

Lists all operations in a project in the specified zone or all zones.
 
 Args:
-  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -232,7 +232,7 @@ 

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -262,7 +262,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], }
diff --git a/docs/dyn/datacatalog_v1.entries.html b/docs/dyn/datacatalog_v1.entries.html index eba3a64ecc..fe443ef1f5 100644 --- a/docs/dyn/datacatalog_v1.entries.html +++ b/docs/dyn/datacatalog_v1.entries.html @@ -164,9 +164,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -185,10 +185,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -211,9 +211,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -232,7 +232,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, diff --git a/docs/dyn/datacatalog_v1.organizations.locations.html b/docs/dyn/datacatalog_v1.organizations.locations.html index 6005dd7bfc..a6808e9b04 100644 --- a/docs/dyn/datacatalog_v1.organizations.locations.html +++ b/docs/dyn/datacatalog_v1.organizations.locations.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

retrieveConfig(name, x__xgafv=None)

-

Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.

+

Retrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects under it which have a separate configuration set.

retrieveEffectiveConfig(name, x__xgafv=None)

-

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

+

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

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

-

Sets the configuration related to the migration to Dataplex for an organization or project.

+

Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.

Method Details

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

Method Details

retrieveConfig(name, x__xgafv=None) -
Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.
+  
Retrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects under it which have a separate configuration set.
 
 Args:
   name: string, Required. The organization whose config is being retrieved. (required)
@@ -106,11 +106,11 @@ 

Method Details

Returns: An object of the form: - { # The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig. + { # The configuration related to the migration from Data Catalog to Dataplex Universal Catalog that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig. "config": { # Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`. - "a_key": { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + "a_key": { # The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. "templateMigrationEnabledTime": "A String", # The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. }, }, @@ -119,7 +119,7 @@

Method Details

retrieveEffectiveConfig(name, x__xgafv=None) -
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
+  
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
 
 Args:
   name: string, Required. The resource whose effective config is being retrieved. (required)
@@ -131,16 +131,16 @@ 

Method Details

Returns: An object of the form: - { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + { # The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. "templateMigrationEnabledTime": "A String", # The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. }
setConfig(name, body=None, x__xgafv=None) -
Sets the configuration related to the migration to Dataplex for an organization or project.
+  
Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.
 
 Args:
   name: string, Required. The organization or project whose config is being specified. (required)
@@ -148,8 +148,8 @@ 

Method Details

The object takes the form of: { # Request message for SetConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. } x__xgafv: string, V1 error format. @@ -160,9 +160,9 @@

Method Details

Returns: An object of the form: - { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + { # The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. "templateMigrationEnabledTime": "A String", # The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. }
diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html index 8c95e6b056..ff9469f293 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html @@ -196,9 +196,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -217,10 +217,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -243,9 +243,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -264,7 +264,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, @@ -471,9 +471,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -492,10 +492,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -518,9 +518,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -539,7 +539,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, @@ -770,9 +770,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -791,10 +791,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -817,9 +817,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -838,7 +838,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, @@ -1031,7 +1031,7 @@

Method Details

{ # Request message for ImportEntries method. "gcsBucketPath": "A String", # Path to a Cloud Storage bucket that contains a dump ready for ingestion. - "jobId": "A String", # Optional. (Optional) Dataplex task job id, if specified will be used as part of ImportEntries LRO ID + "jobId": "A String", # Optional. (Optional) Dataplex Universal Catalog task job id, if specified will be used as part of ImportEntries LRO ID } x__xgafv: string, V1 error format. @@ -1142,9 +1142,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1163,10 +1163,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -1189,9 +1189,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1210,7 +1210,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, @@ -1501,9 +1501,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1522,10 +1522,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -1548,9 +1548,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1569,7 +1569,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, @@ -1776,9 +1776,9 @@

Method Details

"sqlQuery": "A String", # SQL query used to generate this view. "viewType": "A String", # Type of this view. }, - "dataplexTable": { # Entry specification for a Dataplex table. # Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexTable": { # Entry specification for a Dataplex Universal Catalog table. # Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1797,10 +1797,10 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, - "externalTables": [ # List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems. - { # External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. + "externalTables": [ # List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems. + { # External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them "external tables". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog. "dataCatalogEntry": "A String", # Name of the Data Catalog entry representing the external table. "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the external table. "googleCloudResource": "A String", # Google Cloud resource name of the external table. @@ -1823,9 +1823,9 @@

Method Details

"storageType": "A String", # Output only. Type of underlying storage for the FeatureOnlineStore. }, "filesetSpec": { # Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. # Specification that applies to a fileset resource. Valid only for entries with the `FILESET` type. - "dataplexFileset": { # Entry specyfication for a Dataplex fileset. # Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries. - "dataplexSpec": { # Common Dataplex fields. # Common Dataplex fields. - "asset": "A String", # Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. + "dataplexFileset": { # Entry specification for a Dataplex Universal Catalog fileset. # Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries. + "dataplexSpec": { # Common Dataplex Universal Catalog fields. # Common Dataplex Universal Catalog fields. + "asset": "A String", # Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached. "compressionFormat": "A String", # Compression format of the data, e.g., zip, gzip etc. "dataFormat": { # Native schema used by a resource represented as an entry. Used by query engines for deserializing and parsing source data. # Format of the data. "avro": { # Schema in Avro JSON format. # Schema in Avro JSON format. @@ -1844,7 +1844,7 @@

Method Details

"text": "A String", # Thrift IDL source of the schema. }, }, - "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset. + "projectId": "A String", # Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset. }, }, }, diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html index ae53d40c6b..36107d9e88 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.html @@ -138,7 +138,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. } entryGroupId: string, Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. @@ -159,7 +159,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }
@@ -206,7 +206,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }
@@ -280,7 +280,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }, ], "nextPageToken": "A String", # Pagination token to specify in the next call to retrieve the next page of results. Empty if there are no more items. @@ -319,7 +319,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. } updateMask: string, Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. @@ -340,7 +340,7 @@

Method Details

"description": "A String", # Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. "displayName": "A String", # A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. "name": "A String", # Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. - "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. + "transferredToDataplex": True or False, # Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. }
diff --git a/docs/dyn/datacatalog_v1.projects.locations.html b/docs/dyn/datacatalog_v1.projects.locations.html index bdc54d8003..cb8b0ec55f 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.html +++ b/docs/dyn/datacatalog_v1.projects.locations.html @@ -99,10 +99,10 @@

Instance Methods

Close httplib2 connections.

retrieveEffectiveConfig(name, x__xgafv=None)

-

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

+

Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.

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

-

Sets the configuration related to the migration to Dataplex for an organization or project.

+

Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.

Method Details

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

Method Details

retrieveEffectiveConfig(name, x__xgafv=None) -
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
+  
Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
 
 Args:
   name: string, Required. The resource whose effective config is being retrieved. (required)
@@ -123,16 +123,16 @@ 

Method Details

Returns: An object of the form: - { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + { # The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. "templateMigrationEnabledTime": "A String", # The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. }
setConfig(name, body=None, x__xgafv=None) -
Sets the configuration related to the migration to Dataplex for an organization or project.
+  
Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.
 
 Args:
   name: string, Required. The organization or project whose config is being specified. (required)
@@ -140,8 +140,8 @@ 

Method Details

The object takes the form of: { # Request message for SetConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. } x__xgafv: string, V1 error format. @@ -152,9 +152,9 @@

Method Details

Returns: An object of the form: - { # The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. - "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex. - "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex. + { # The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig. + "catalogUiExperience": "A String", # Opt-in status for the UI switch to Dataplex Universal Catalog. + "tagTemplateMigration": "A String", # Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog. "templateMigrationEnabledTime": "A String", # The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set. }
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index a47315d7f5..59f6d05cf6 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -309,7 +309,7 @@

Method Details

Args: name: string, Required. The repository's name. (required) - force: boolean, Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) + force: boolean, Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datafusion_v1.projects.locations.instances.html b/docs/dyn/datafusion_v1.projects.locations.instances.html index 77640f1d65..b9e7ea9ca1 100644 --- a/docs/dyn/datafusion_v1.projects.locations.instances.html +++ b/docs/dyn/datafusion_v1.projects.locations.instances.html @@ -86,7 +86,7 @@

Instance Methods

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

Creates a new Data Fusion instance in the specified project and location.

- delete(name, x__xgafv=None)

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

Deletes a single Date Fusion instance.

get(name, x__xgafv=None)

@@ -258,11 +258,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None)
Deletes a single Date Fusion instance.
 
 Args:
   name: string, Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} (required)
+  force: boolean, Optional. If set to true, any nested resources from this instance will also be deleted.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/datafusion_v1beta1.projects.locations.instances.dnsPeerings.html b/docs/dyn/datafusion_v1beta1.projects.locations.instances.dnsPeerings.html
index 4ad7a60fa0..8ecd842c42 100644
--- a/docs/dyn/datafusion_v1beta1.projects.locations.instances.dnsPeerings.html
+++ b/docs/dyn/datafusion_v1beta1.projects.locations.instances.dnsPeerings.html
@@ -107,7 +107,7 @@ 

Method Details

{ # DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. "description": "A String", # Optional. Optional description of the dns zone. "domain": "A String", # Required. The dns name suffix of the zone. - "name": "A String", # Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} + "name": "A String", # Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} "targetNetwork": "A String", # Optional. Optional target network to which dns peering should happen. "targetProject": "A String", # Optional. Optional target project to which dns peering should happen. } @@ -124,7 +124,7 @@

Method Details

{ # DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. "description": "A String", # Optional. Optional description of the dns zone. "domain": "A String", # Required. The dns name suffix of the zone. - "name": "A String", # Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} + "name": "A String", # Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} "targetNetwork": "A String", # Optional. Optional target network to which dns peering should happen. "targetProject": "A String", # Optional. Optional target project to which dns peering should happen. }
@@ -169,7 +169,7 @@

Method Details

{ # DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. "description": "A String", # Optional. Optional description of the dns zone. "domain": "A String", # Required. The dns name suffix of the zone. - "name": "A String", # Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} + "name": "A String", # Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} "targetNetwork": "A String", # Optional. Optional target network to which dns peering should happen. "targetProject": "A String", # Optional. Optional target project to which dns peering should happen. }, diff --git a/docs/dyn/datafusion_v1beta1.projects.locations.instances.html b/docs/dyn/datafusion_v1beta1.projects.locations.instances.html index 63aef8d89e..8c315a3f10 100644 --- a/docs/dyn/datafusion_v1beta1.projects.locations.instances.html +++ b/docs/dyn/datafusion_v1beta1.projects.locations.instances.html @@ -91,7 +91,7 @@

Instance Methods

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

Creates a new Data Fusion instance in the specified project and location.

- delete(name, x__xgafv=None)

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

Deletes a single Data Fusion instance.

get(name, x__xgafv=None)

@@ -154,21 +154,21 @@

Method Details

}, ], "createTime": "A String", # Output only. The time the instance was created. - "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. - "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. + "keyReference": "A String", # Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. }, "dataplexDataLineageIntegrationEnabled": True or False, # Optional. Option to enable the Dataplex Lineage Integration feature. - "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. - "description": "A String", # A description of this instance. + "dataprocServiceAccount": "A String", # Optional. User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. + "description": "A String", # Optional. A description of this instance. "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. "A String", ], - "displayName": "A String", # Display name for an instance. - "enableRbac": True or False, # Option to enable granular role-based access control. - "enableStackdriverLogging": True or False, # Option to enable Dataproc Stackdriver Logging. - "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. - "enableZoneSeparation": True or False, # Option to enable zone separation. - "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Option to enable and pass metadata for event publishing. + "displayName": "A String", # Optional. Display name for an instance. + "enableRbac": True or False, # Optional. Option to enable granular role-based access control. + "enableStackdriverLogging": True or False, # Optional. Option to enable Dataproc Stackdriver Logging. + "enableStackdriverMonitoring": True or False, # Optional. Option to enable Stackdriver Monitoring. + "enableZoneSeparation": True or False, # Output only. Option to enable zone separation. + "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Optional. Option to enable and pass metadata for event publishing. "enabled": True or False, # Required. Option to enable Event Publishing. "topic": "A String", # Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id} }, @@ -202,7 +202,7 @@

Method Details

}, }, "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. - "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. + "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. "connectionType": "A String", # Optional. Type of connection for establishing private IP connectivity between the Data Fusion customer project VPC and the corresponding tenant project from a predefined list of available connection modes. If this field is unspecified for a private instance, VPC peering is used. "ipAllocation": "A String", # Optional. The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. This is required only when using connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22 "network": "A String", # Optional. Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only required for connectivity type VPC_PEERING. @@ -212,12 +212,12 @@

Method Details

"unreachableCidrBlock": "A String", # Optional. Input only. The CIDR block to which the CDF instance can't route traffic to in the consumer project VPC. The size of this block should be at least /25. This range should not overlap with the primary address range of any subnetwork used by the network attachment. This range can be used for other purposes in the consumer VPC as long as there is no requirement for CDF to reach destinations using these addresses. If this value is not provided, the server chooses a non RFC 1918 address range. The format of this field is governed by RFC 4632. Example: 192.168.0.0/25 }, }, - "options": { # Map of additional options used to configure the behavior of Data Fusion instance. + "options": { # Optional. Map of additional options used to configure the behavior of Data Fusion instance. "a_key": "A String", }, "p4ServiceAccount": "A String", # Output only. Service agent for the customer project. "patchRevision": "A String", # Optional. Current patch revision of the Data Fusion. - "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. + "privateInstance": True or False, # Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. @@ -230,9 +230,9 @@

Method Details

"tenantProjectId": "A String", # Output only. The name of the tenant project. "type": "A String", # Required. Instance type. "updateTime": "A String", # Output only. The time the instance was last updated. - "version": "A String", # Current version of Data Fusion. + "version": "A String", # Optional. Current version of Data Fusion. "workforceIdentityServiceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible to third-party users. - "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. + "zone": "A String", # Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. } instanceId: string, Required. The name of the instance to create. Instance name can only contain lowercase alphanumeric characters and hyphens. It must start with a letter and must not end with a hyphen. It can have a maximum of 30 characters. @@ -266,11 +266,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None)
Deletes a single Data Fusion instance.
 
 Args:
   name: string, Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} (required)
+  force: boolean, Optional. If set to true, any nested resources from this instance will also be deleted.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -333,21 +334,21 @@ 

Method Details

}, ], "createTime": "A String", # Output only. The time the instance was created. - "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. - "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. + "keyReference": "A String", # Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. }, "dataplexDataLineageIntegrationEnabled": True or False, # Optional. Option to enable the Dataplex Lineage Integration feature. - "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. - "description": "A String", # A description of this instance. + "dataprocServiceAccount": "A String", # Optional. User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. + "description": "A String", # Optional. A description of this instance. "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. "A String", ], - "displayName": "A String", # Display name for an instance. - "enableRbac": True or False, # Option to enable granular role-based access control. - "enableStackdriverLogging": True or False, # Option to enable Dataproc Stackdriver Logging. - "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. - "enableZoneSeparation": True or False, # Option to enable zone separation. - "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Option to enable and pass metadata for event publishing. + "displayName": "A String", # Optional. Display name for an instance. + "enableRbac": True or False, # Optional. Option to enable granular role-based access control. + "enableStackdriverLogging": True or False, # Optional. Option to enable Dataproc Stackdriver Logging. + "enableStackdriverMonitoring": True or False, # Optional. Option to enable Stackdriver Monitoring. + "enableZoneSeparation": True or False, # Output only. Option to enable zone separation. + "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Optional. Option to enable and pass metadata for event publishing. "enabled": True or False, # Required. Option to enable Event Publishing. "topic": "A String", # Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id} }, @@ -381,7 +382,7 @@

Method Details

}, }, "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. - "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. + "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. "connectionType": "A String", # Optional. Type of connection for establishing private IP connectivity between the Data Fusion customer project VPC and the corresponding tenant project from a predefined list of available connection modes. If this field is unspecified for a private instance, VPC peering is used. "ipAllocation": "A String", # Optional. The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. This is required only when using connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22 "network": "A String", # Optional. Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only required for connectivity type VPC_PEERING. @@ -391,12 +392,12 @@

Method Details

"unreachableCidrBlock": "A String", # Optional. Input only. The CIDR block to which the CDF instance can't route traffic to in the consumer project VPC. The size of this block should be at least /25. This range should not overlap with the primary address range of any subnetwork used by the network attachment. This range can be used for other purposes in the consumer VPC as long as there is no requirement for CDF to reach destinations using these addresses. If this value is not provided, the server chooses a non RFC 1918 address range. The format of this field is governed by RFC 4632. Example: 192.168.0.0/25 }, }, - "options": { # Map of additional options used to configure the behavior of Data Fusion instance. + "options": { # Optional. Map of additional options used to configure the behavior of Data Fusion instance. "a_key": "A String", }, "p4ServiceAccount": "A String", # Output only. Service agent for the customer project. "patchRevision": "A String", # Optional. Current patch revision of the Data Fusion. - "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. + "privateInstance": True or False, # Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. @@ -409,9 +410,9 @@

Method Details

"tenantProjectId": "A String", # Output only. The name of the tenant project. "type": "A String", # Required. Instance type. "updateTime": "A String", # Output only. The time the instance was last updated. - "version": "A String", # Current version of Data Fusion. + "version": "A String", # Optional. Current version of Data Fusion. "workforceIdentityServiceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible to third-party users. - "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. + "zone": "A String", # Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. }
@@ -502,21 +503,21 @@

Method Details

}, ], "createTime": "A String", # Output only. The time the instance was created. - "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. - "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. + "keyReference": "A String", # Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. }, "dataplexDataLineageIntegrationEnabled": True or False, # Optional. Option to enable the Dataplex Lineage Integration feature. - "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. - "description": "A String", # A description of this instance. + "dataprocServiceAccount": "A String", # Optional. User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. + "description": "A String", # Optional. A description of this instance. "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. "A String", ], - "displayName": "A String", # Display name for an instance. - "enableRbac": True or False, # Option to enable granular role-based access control. - "enableStackdriverLogging": True or False, # Option to enable Dataproc Stackdriver Logging. - "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. - "enableZoneSeparation": True or False, # Option to enable zone separation. - "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Option to enable and pass metadata for event publishing. + "displayName": "A String", # Optional. Display name for an instance. + "enableRbac": True or False, # Optional. Option to enable granular role-based access control. + "enableStackdriverLogging": True or False, # Optional. Option to enable Dataproc Stackdriver Logging. + "enableStackdriverMonitoring": True or False, # Optional. Option to enable Stackdriver Monitoring. + "enableZoneSeparation": True or False, # Output only. Option to enable zone separation. + "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Optional. Option to enable and pass metadata for event publishing. "enabled": True or False, # Required. Option to enable Event Publishing. "topic": "A String", # Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id} }, @@ -550,7 +551,7 @@

Method Details

}, }, "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. - "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. + "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. "connectionType": "A String", # Optional. Type of connection for establishing private IP connectivity between the Data Fusion customer project VPC and the corresponding tenant project from a predefined list of available connection modes. If this field is unspecified for a private instance, VPC peering is used. "ipAllocation": "A String", # Optional. The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. This is required only when using connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22 "network": "A String", # Optional. Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only required for connectivity type VPC_PEERING. @@ -560,12 +561,12 @@

Method Details

"unreachableCidrBlock": "A String", # Optional. Input only. The CIDR block to which the CDF instance can't route traffic to in the consumer project VPC. The size of this block should be at least /25. This range should not overlap with the primary address range of any subnetwork used by the network attachment. This range can be used for other purposes in the consumer VPC as long as there is no requirement for CDF to reach destinations using these addresses. If this value is not provided, the server chooses a non RFC 1918 address range. The format of this field is governed by RFC 4632. Example: 192.168.0.0/25 }, }, - "options": { # Map of additional options used to configure the behavior of Data Fusion instance. + "options": { # Optional. Map of additional options used to configure the behavior of Data Fusion instance. "a_key": "A String", }, "p4ServiceAccount": "A String", # Output only. Service agent for the customer project. "patchRevision": "A String", # Optional. Current patch revision of the Data Fusion. - "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. + "privateInstance": True or False, # Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. @@ -578,9 +579,9 @@

Method Details

"tenantProjectId": "A String", # Output only. The name of the tenant project. "type": "A String", # Required. Instance type. "updateTime": "A String", # Output only. The time the instance was last updated. - "version": "A String", # Current version of Data Fusion. + "version": "A String", # Optional. Current version of Data Fusion. "workforceIdentityServiceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible to third-party users. - "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. + "zone": "A String", # Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. @@ -632,21 +633,21 @@

Method Details

}, ], "createTime": "A String", # Output only. The time the instance was created. - "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. - "keyReference": "A String", # The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + "cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. + "keyReference": "A String", # Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. }, "dataplexDataLineageIntegrationEnabled": True or False, # Optional. Option to enable the Dataplex Lineage Integration feature. - "dataprocServiceAccount": "A String", # User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. - "description": "A String", # A description of this instance. + "dataprocServiceAccount": "A String", # Optional. User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. + "description": "A String", # Optional. A description of this instance. "disabledReason": [ # Output only. If the instance state is DISABLED, the reason for disabling the instance. "A String", ], - "displayName": "A String", # Display name for an instance. - "enableRbac": True or False, # Option to enable granular role-based access control. - "enableStackdriverLogging": True or False, # Option to enable Dataproc Stackdriver Logging. - "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring. - "enableZoneSeparation": True or False, # Option to enable zone separation. - "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Option to enable and pass metadata for event publishing. + "displayName": "A String", # Optional. Display name for an instance. + "enableRbac": True or False, # Optional. Option to enable granular role-based access control. + "enableStackdriverLogging": True or False, # Optional. Option to enable Dataproc Stackdriver Logging. + "enableStackdriverMonitoring": True or False, # Optional. Option to enable Stackdriver Monitoring. + "enableZoneSeparation": True or False, # Output only. Option to enable zone separation. + "eventPublishConfig": { # Confirguration of PubSubEventWriter. # Optional. Option to enable and pass metadata for event publishing. "enabled": True or False, # Required. Option to enable Event Publishing. "topic": "A String", # Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id} }, @@ -680,7 +681,7 @@

Method Details

}, }, "name": "A String", # Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. - "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Network configuration options. These are required when a private Data Fusion instance is to be created. + "networkConfig": { # Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. # Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. "connectionType": "A String", # Optional. Type of connection for establishing private IP connectivity between the Data Fusion customer project VPC and the corresponding tenant project from a predefined list of available connection modes. If this field is unspecified for a private instance, VPC peering is used. "ipAllocation": "A String", # Optional. The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. This is required only when using connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22 "network": "A String", # Optional. Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only required for connectivity type VPC_PEERING. @@ -690,12 +691,12 @@

Method Details

"unreachableCidrBlock": "A String", # Optional. Input only. The CIDR block to which the CDF instance can't route traffic to in the consumer project VPC. The size of this block should be at least /25. This range should not overlap with the primary address range of any subnetwork used by the network attachment. This range can be used for other purposes in the consumer VPC as long as there is no requirement for CDF to reach destinations using these addresses. If this value is not provided, the server chooses a non RFC 1918 address range. The format of this field is governed by RFC 4632. Example: 192.168.0.0/25 }, }, - "options": { # Map of additional options used to configure the behavior of Data Fusion instance. + "options": { # Optional. Map of additional options used to configure the behavior of Data Fusion instance. "a_key": "A String", }, "p4ServiceAccount": "A String", # Output only. Service agent for the customer project. "patchRevision": "A String", # Optional. Current patch revision of the Data Fusion. - "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. + "privateInstance": True or False, # Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. @@ -708,9 +709,9 @@

Method Details

"tenantProjectId": "A String", # Output only. The name of the tenant project. "type": "A String", # Required. Instance type. "updateTime": "A String", # Output only. The time the instance was last updated. - "version": "A String", # Current version of Data Fusion. + "version": "A String", # Optional. Current version of Data Fusion. "workforceIdentityServiceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible to third-party users. - "zone": "A String", # Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. + "zone": "A String", # Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. } updateMask: string, Field mask is used to specify the fields that the update will overwrite in an instance resource. 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, all the supported fields (labels and options currently) will be overwritten. diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index 1e0e9020f0..3f6eb87145 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -479,6 +479,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -1185,6 +1186,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -1918,6 +1920,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -2715,6 +2718,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -3462,6 +3466,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -4277,6 +4282,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -4983,6 +4989,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 19219882fe..4b7fc9f3a3 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -223,6 +223,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -878,6 +879,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -1494,6 +1496,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -2030,6 +2033,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index 1ff4a08e14..1688cdf82c 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -479,6 +479,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -1185,6 +1186,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -1918,6 +1920,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -2715,6 +2718,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -3462,6 +3466,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -4277,6 +4282,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. @@ -4983,6 +4989,7 @@

Method Details

"nodeGroupId": "A String", # Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. }, ], + "clusterTier": "A String", # Optional. The tier of the cluster. "clusterType": "A String", # Optional. The type of the cluster. "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. "dataprocMetricConfig": { # Dataproc metric config. # Optional. The config for Dataproc metrics. diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index dfbdfaa6f7..66289063ae 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -768,22 +768,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -898,22 +898,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html index 3a76d99242..9f5b2d0c1b 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html @@ -135,22 +135,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.generators.html b/docs/dyn/dialogflow_v2.projects.generators.html index a21ffaa393..e6880737ae 100644 --- a/docs/dyn/dialogflow_v2.projects.generators.html +++ b/docs/dyn/dialogflow_v2.projects.generators.html @@ -146,22 +146,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -248,22 +248,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -360,22 +360,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index 2f87df187c..88cc822774 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -768,22 +768,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -898,22 +898,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html index a227dc2a4f..8a72c851a4 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html @@ -135,22 +135,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.locations.generators.html b/docs/dyn/dialogflow_v2.projects.locations.generators.html index 67da740a19..6b150c61fe 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.html @@ -155,22 +155,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -257,22 +257,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -383,22 +383,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -495,22 +495,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -615,22 +615,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -717,22 +717,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html b/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html index 11eaaa3462..1fca89ff39 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html +++ b/docs/dyn/dialogflow_v2.projects.locations.statelessSuggestion.html @@ -165,22 +165,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -243,22 +243,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index c6c72d6ce1..61e6cf36a1 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -1723,22 +1723,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -3216,22 +3216,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html index 00b5a5eb39..bc1e5c1e6a 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html @@ -135,22 +135,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.generators.html b/docs/dyn/dialogflow_v2beta1.projects.generators.html index 2a39c5733f..f5277aa0a1 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.generators.html @@ -146,22 +146,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -248,22 +248,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -360,22 +360,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 2fba99de1e..8640d98533 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -1723,22 +1723,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -3216,22 +3216,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html index f4d5adf40a..a56319719e 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html @@ -135,22 +135,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html index edcdca487c..b21d7c9dd0 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html @@ -155,22 +155,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -257,22 +257,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -383,22 +383,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -495,22 +495,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -615,22 +615,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -717,22 +717,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html b/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html index 31e71915de..e604d3bdd1 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.statelessSuggestion.html @@ -165,22 +165,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], @@ -243,22 +243,22 @@

Method Details

"toolCallInfo": [ # Optional. List of request and response for tool calls executed. { # Request and response for a tool call. "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "createTime": "A String", # Output only. Create time of the tool call. "inputParameters": { # Optional. The action's input parameters. "a_key": "", # Properties of the object. }, - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call. - "action": "A String", # Required. The name of the tool's action associated with this call. + "action": "A String", # Optional. The name of the tool's action associated with this call. "content": "A String", # Only populated if the response content is utf-8 encoded. "createTime": "A String", # Output only. Create time of the tool call result. "error": { # An error produced by the tool call. # The tool call's error. "message": "A String", # Optional. The error message of the function. }, "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded). - "tool": "A String", # Required. The tool associated with this call. Format: `projects//locations//tools/`. + "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`. }, }, ], diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index 754f347d67..075cf1c20e 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -191,6 +191,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -1734,6 +1735,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -3252,6 +3254,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -4557,6 +4560,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index 05569757b0..b8f26c5a48 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -194,6 +194,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -1737,6 +1738,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -3255,6 +3257,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -4560,6 +4563,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index b0e7fdd07c..a7267b8245 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -3060,6 +3060,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -9338,6 +9339,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index 2a53be011a..4ff9aae79b 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -191,6 +191,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -2522,6 +2523,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -4827,6 +4829,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -6120,6 +6123,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index b1e6dd3289..07bdf65e01 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -194,6 +194,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -2525,6 +2526,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -4830,6 +4832,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, @@ -6123,6 +6126,7 @@

Method Details

"model": "A String", # The selected LLM model. "promptText": "A String", # The custom prompt to use. }, + "parameterScope": "A String", # Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id. "parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. You can reference the session parameters in the agent with the following format: $session.params.parameter-id. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html index de3e773514..6178ec47d4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html @@ -123,6 +123,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -180,6 +181,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -261,6 +263,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -399,6 +402,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -506,6 +510,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -581,6 +586,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -639,6 +645,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html index f964e9de42..f451f961db 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html @@ -404,6 +404,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 7992506951..6642e21f8e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -144,7 +144,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -426,7 +426,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -563,13 +563,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -945,6 +942,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1253,6 +1251,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1622,6 +1621,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1803,7 +1803,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2085,7 +2085,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2222,13 +2222,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 0c1261a123..fc9cc0db0a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -261,13 +261,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -290,7 +287,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -427,13 +424,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -482,7 +476,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -619,13 +613,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -662,7 +653,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -799,13 +790,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -846,7 +834,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -983,13 +971,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1013,7 +998,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1150,13 +1135,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html index a0f6630f3f..bf765cdc78 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html @@ -404,6 +404,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 d0b32f6c95..a965fbd9d5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -144,7 +144,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -426,7 +426,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -563,13 +563,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -945,6 +942,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1253,6 +1251,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1622,6 +1621,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1803,7 +1803,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2085,7 +2085,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2222,13 +2222,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 9dcc277f19..1055dae743 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -261,13 +261,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -290,7 +287,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -427,13 +424,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -482,7 +476,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -619,13 +613,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -662,7 +653,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -799,13 +790,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -846,7 +834,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -983,13 +971,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1013,7 +998,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1150,13 +1135,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html index 538b579cd5..c213e240c0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -123,6 +123,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -180,6 +181,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -261,6 +263,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -399,6 +402,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -506,6 +510,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -581,6 +586,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -639,6 +645,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html index 5f2ec11d84..82b0c838f1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html @@ -404,6 +404,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 2493ba5164..1978752e1b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -144,7 +144,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -426,7 +426,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -563,13 +563,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -945,6 +942,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1253,6 +1251,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1622,6 +1621,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1803,7 +1803,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2085,7 +2085,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2222,13 +2222,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index 218f015544..7b50425f25 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -261,13 +261,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -290,7 +287,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -427,13 +424,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -482,7 +476,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -619,13 +613,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -662,7 +653,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -799,13 +790,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -846,7 +834,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -983,13 +971,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1013,7 +998,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1150,13 +1135,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index 7db8e89192..2cbcfa787d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -131,6 +131,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -188,6 +189,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -269,6 +271,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -439,6 +442,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -546,6 +550,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -621,6 +626,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -679,6 +685,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html index dd1c0b804b..49879b320e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html @@ -148,6 +148,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -205,6 +206,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html index 7a9b882aa1..93d7f71502 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 716a02bba1..f1cc4999f8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -462,7 +462,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -614,13 +614,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1303,6 +1300,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1522,7 +1520,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1542,6 +1540,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -1699,6 +1698,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1808,6 +1808,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2101,7 +2102,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2121,6 +2122,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -2278,6 +2280,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2387,6 +2390,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2584,7 +2588,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2890,7 +2894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -3042,13 +3046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 08bf8f7521..540d47e852 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html index 84f4f9625b..d5fba2c650 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html @@ -151,6 +151,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -208,6 +209,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index 49c7010116..8c621c3366 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 ea2ff6bdb4..da07410c60 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -462,7 +462,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -614,13 +614,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1303,6 +1300,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1522,7 +1520,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1542,6 +1540,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -1699,6 +1698,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1808,6 +1808,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2101,7 +2102,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2121,6 +2122,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -2278,6 +2280,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2387,6 +2390,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2584,7 +2588,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2890,7 +2894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -3042,13 +3046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 8dbe7cdd4c..7dffe96b1e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index cbbf18175d..41aee39f4b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -131,6 +131,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -188,6 +189,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -269,6 +271,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -439,6 +442,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -546,6 +550,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -621,6 +626,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -679,6 +685,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html index 5f7f9e38d0..3021121139 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html @@ -148,6 +148,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -205,6 +206,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html index 688a5c6eba..9db937a5f3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index f430f512f9..a4fc31fe75 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -462,7 +462,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -614,13 +614,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1303,6 +1300,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1522,7 +1520,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1542,6 +1540,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -1699,6 +1698,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1808,6 +1808,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2101,7 +2102,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2121,6 +2122,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -2278,6 +2280,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2387,6 +2390,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2584,7 +2588,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2890,7 +2894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -3042,13 +3046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 925f38f258..762421f8ef 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index b9d1b35535..d2d6185b25 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -302,7 +302,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -322,6 +322,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -599,7 +600,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -619,6 +620,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. @@ -872,7 +874,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -892,6 +894,7 @@

Method Details

"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect. "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, + "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index 5a100433b5..67a747fefb 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -123,6 +123,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -180,6 +181,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -261,6 +263,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -399,6 +402,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -506,6 +510,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -581,6 +586,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -639,6 +645,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index 9c44c75d61..13836a73e0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -148,6 +148,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -205,6 +206,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html index 790018672b..bd468cd161 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 59cbe43d57..9111bd5e21 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -459,7 +459,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -611,13 +611,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1268,6 +1265,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1484,7 +1482,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1661,6 +1659,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1770,6 +1769,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2060,7 +2060,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2237,6 +2237,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2346,6 +2347,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2543,7 +2545,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2846,7 +2848,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2998,13 +3000,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 a4d0df18b9..ab06cb32b1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index 351076a318..087760e569 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -151,6 +151,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -208,6 +209,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html index e7ce560787..2e3426ca3b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, 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 bcabd6a2fa..b453de616f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -459,7 +459,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -611,13 +611,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1268,6 +1265,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1484,7 +1482,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1661,6 +1659,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1770,6 +1769,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2060,7 +2060,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2237,6 +2237,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2346,6 +2347,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2543,7 +2545,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2846,7 +2848,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2998,13 +3000,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. 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 1b2a8f5ad0..1abec9c8e6 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index 856d86033e..04deb15b20 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -123,6 +123,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -180,6 +181,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -261,6 +263,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -399,6 +402,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -506,6 +510,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -581,6 +586,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -639,6 +645,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index 1467341424..f2cac290b0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -148,6 +148,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -205,6 +206,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html index 7031941db5..58c76c5969 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html @@ -473,6 +473,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 1ee15c7650..65673d9e66 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -156,7 +156,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -459,7 +459,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -611,13 +611,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1268,6 +1265,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1484,7 +1482,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -1661,6 +1659,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -1770,6 +1769,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2060,7 +2060,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -2237,6 +2237,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2346,6 +2347,7 @@

Method Details

"idpWide": True or False, # All users within the Identity Provider. "principals": [ # List of principals. { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. }, @@ -2543,7 +2545,7 @@

Method Details

"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. }, "query": { # Defines a user inputed query. # Required. Current user query. - "queryId": "A String", # Unique Id for the query. + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification. @@ -2846,7 +2848,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -2998,13 +3000,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index a26c76bc67..5b2d6e7257 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -124,7 +124,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -276,13 +276,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -305,7 +302,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -457,13 +454,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -512,7 +506,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -664,13 +658,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -707,7 +698,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -859,13 +850,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -906,7 +894,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1058,13 +1046,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. @@ -1088,7 +1073,7 @@

Method Details

"state": "A String", # The state of the session. "turns": [ # Turns. { # Represents a turn, including a query from the user and a answer from service. - "answer": "A String", # The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + "answer": "A String", # Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. "detailedAnswer": { # Defines an answer. # Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", @@ -1240,13 +1225,10 @@

Method Details

}, ], }, - "query": { # Defines a user inputed query. # The user query. - "queryId": "A String", # Unique Id for the query. + "query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn + "queryId": "A String", # Output only. Unique Id for the query. "text": "A String", # Plain text. }, - "queryConfigs": { # Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix "google." will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with "google..". 3P services can use anything not starting with "google." - "a_key": "A String", - }, }, ], "userPseudoId": "A String", # A unique identifier for tracking users. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 35fc6f6eec..344c3903d5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -299,7 +299,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -593,7 +593,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. @@ -863,7 +863,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", # 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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result "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. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 4c7f4b99e1..7ae1111251 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -337,7 +337,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -680,7 +680,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1047,7 +1047,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1401,7 +1401,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1763,7 +1763,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -2107,7 +2107,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 45a117aac0..da04fd617c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -425,7 +425,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1176,7 +1176,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index c09fb537cf..c4edb171d6 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -425,7 +425,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1120,7 +1120,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 5773f4df9b..952a664bbc 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -337,7 +337,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -680,7 +680,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1047,7 +1047,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1401,7 +1401,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1763,7 +1763,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -2107,7 +2107,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 1e13917807..d1ba581d4c 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -425,7 +425,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1176,7 +1176,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index e8198a2a84..21016dc106 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -425,7 +425,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. @@ -1120,7 +1120,7 @@

Method Details

"bucketName": "A String", # Required. The bucket to scan. "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. }, - "collection": { # Match file stores (e.g. buckets) using regex filters. # Optional. A specific set of buckets for this filter to apply to. + "collection": { # Match file stores (e.g. buckets) using filters. # Optional. A specific set of buckets for this filter to apply to. "includeRegexes": { # A collection of regular expressions to determine what file store to match against. # Optional. A collection of regular expressions to match a file store against. "patterns": [ # Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. { # A pattern to match against one or more file stores. diff --git a/docs/dyn/fcm_v1.projects.messages.html b/docs/dyn/fcm_v1.projects.messages.html index 6aac456e76..e84f136adf 100644 --- a/docs/dyn/fcm_v1.projects.messages.html +++ b/docs/dyn/fcm_v1.projects.messages.html @@ -103,7 +103,7 @@

Method Details

"data": { # Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. "a_key": "A String", }, - "directBootOk": True or False, # If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). + "directBootOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). "fcmOptions": { # Options for features provided by the FCM SDK for Android. # Options for features provided by the FCM SDK for Android. "analyticsLabel": "A String", # Label associated with the message's analytics data. }, @@ -153,6 +153,7 @@

Method Details

}, "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. + "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are allowed to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. }, "apns": { # [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. # Input only. [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. @@ -217,7 +218,7 @@

Method Details

"data": { # Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. "a_key": "A String", }, - "directBootOk": True or False, # If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). + "directBootOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot). "fcmOptions": { # Options for features provided by the FCM SDK for Android. # Options for features provided by the FCM SDK for Android. "analyticsLabel": "A String", # Label associated with the message's analytics data. }, @@ -267,6 +268,7 @@

Method Details

}, "priority": "A String", # Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). "restrictedPackageName": "A String", # Package name of the application where the registration token must match in order to receive the message. + "restrictedSatelliteOk": True or False, # Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are allowed to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model. "ttl": "A String", # How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. }, "apns": { # [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. # Input only. [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index d135405fe1..ed68f75e68 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -161,6 +161,15 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "enterText": { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text. + "elementBounds": { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into. + "bottom": 42, + "left": 42, + "right": 42, + "top": 42, + }, + "text": "A String", # Output only. The text to enter. + }, "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. @@ -181,7 +190,7 @@

Method Details

"xCoordinate": 42, "yCoordinate": 42, }, - "textInput": "A String", # Output only. Text entered for a text entry action. + "textInput": "A String", # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one. "wait": { # A wait action. # Output only. A wait action. "duration": "A String", # Output only. The duration of the wait. }, @@ -296,6 +305,15 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "enterText": { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text. + "elementBounds": { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into. + "bottom": 42, + "left": 42, + "right": 42, + "top": 42, + }, + "text": "A String", # Output only. The text to enter. + }, "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. @@ -316,7 +334,7 @@

Method Details

"xCoordinate": 42, "yCoordinate": 42, }, - "textInput": "A String", # Output only. Text entered for a text entry action. + "textInput": "A String", # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one. "wait": { # A wait action. # Output only. A wait action. "duration": "A String", # Output only. The duration of the wait. }, @@ -437,6 +455,15 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "enterText": { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text. + "elementBounds": { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into. + "bottom": 42, + "left": 42, + "right": 42, + "top": 42, + }, + "text": "A String", # Output only. The text to enter. + }, "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. @@ -457,7 +484,7 @@

Method Details

"xCoordinate": 42, "yCoordinate": 42, }, - "textInput": "A String", # Output only. Text entered for a text entry action. + "textInput": "A String", # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one. "wait": { # A wait action. # Output only. A wait action. "duration": "A String", # Output only. The duration of the wait. }, @@ -588,6 +615,15 @@

Method Details

"description": "A String", # Output only. A short description of the high level action taken by the AI agent. "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. { # An interaction with the device, such as a tap, text entry, wait, etc. + "enterText": { # A text entry action, that enters text into a particular text field, clearing any existing text in the field. # Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text. + "elementBounds": { # Rectangle for describing bounding boxes # Output only. The visible bounds of the element to enter text into. + "bottom": 42, + "left": 42, + "right": 42, + "top": 42, + }, + "text": "A String", # Output only. The text to enter. + }, "keyCode": "A String", # Output only. Key code for a key event action. "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. "height": 42, # Output only. The height of the screenshot, in pixels. @@ -608,7 +644,7 @@

Method Details

"xCoordinate": 42, "yCoordinate": 42, }, - "textInput": "A String", # Output only. Text entered for a text entry action. + "textInput": "A String", # Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one. "wait": { # A wait action. # Output only. A wait action. "duration": "A String", # Output only. The duration of the wait. }, diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index ffeab5639a..d8afe10208 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -115,7 +115,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -135,7 +135,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -251,7 +251,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -271,7 +271,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -528,7 +528,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -548,7 +548,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -670,7 +670,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -690,7 +690,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -958,7 +958,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -978,7 +978,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -1071,6 +1071,7 @@

Method Details

{ # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. + "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. "probability": "A String", # Output only. Harm probability levels in the content. "probabilityScore": 3.14, # Output only. Harm probability score. "severity": "A String", # Output only. Harm severity levels in the content. @@ -1096,6 +1097,7 @@

Method Details

{ # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. + "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. "probability": "A String", # Output only. Harm probability levels in the content. "probabilityScore": 3.14, # Output only. Harm probability score. "severity": "A String", # Output only. Harm severity levels in the content. @@ -1164,7 +1166,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -1184,7 +1186,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -1306,7 +1308,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -1326,7 +1328,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -1594,7 +1596,7 @@

Method Details

"language": "A String", # Required. Programming language of the `code`. }, "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "fileUri": "A String", # Required. URI. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, @@ -1614,7 +1616,7 @@

Method Details

}, "inlineData": { # Content blob. # Optional. Inlined bytes data. "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). @@ -1707,6 +1709,7 @@

Method Details

{ # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. + "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. "probability": "A String", # Output only. Harm probability levels in the content. "probabilityScore": 3.14, # Output only. Harm probability score. "severity": "A String", # Output only. Harm severity levels in the content. @@ -1732,6 +1735,7 @@

Method Details

{ # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. + "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. "probability": "A String", # Output only. Harm probability levels in the content. "probabilityScore": 3.14, # Output only. Harm probability score. "severity": "A String", # Output only. Harm severity levels in the content. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html index b7585b547b..8980d1ab4e 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.html @@ -110,7 +110,7 @@

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.

- unenroll(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)

+ unenroll(name, allowMissing=None, etag=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)

Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

Method Details

@@ -1400,13 +1400,14 @@

Method Details

- unenroll(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) + unenroll(name, allowMissing=None, etag=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)
Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
 
 Args:
   name: string, Required. Name of the VMware admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}" (required)
   allowMissing: boolean, If set to true, and the VMware admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
   etag: string, The current etag of the VMware admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
+  ignoreErrors: boolean, Optional. If set to true, the unenrollment of a vmware admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.
   validateOnly: boolean, Validate the request without actually doing any updates.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/integrations_v1.projects.locations.connections.html b/docs/dyn/integrations_v1.projects.locations.connections.html
index 24196aa79a..a665ec39a2 100644
--- a/docs/dyn/integrations_v1.projects.locations.connections.html
+++ b/docs/dyn/integrations_v1.projects.locations.connections.html
@@ -351,7 +351,7 @@ 

Method Details

"username": "A String", # Optional. Username. }, }, - "eventingConfig": { # Eventing Configuration of a connection next: 18 # Optional. Eventing config of a connection + "eventingConfig": { # Eventing Configuration of a connection next: 19 # Optional. Eventing config of a connection "additionalVariables": [ # Optional. Additional eventing related field values { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. "boolValue": True or False, # Value is a bool. @@ -520,6 +520,9 @@

Method Details

"username": "A String", # Optional. Username. }, }, + "privateConnectivityAllowlistedProjects": [ # Optional. List of projects to be allowlisted for the service attachment created in the tenant project for eventing ingress. + "A String", + ], "privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled. "proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration. "destinations": [ # The destinations for the key. diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index eddd7a11ee..443c577cbc 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -102,7 +102,7 @@

Instance Methods

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

Updates the template by given id.

- search(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+ search(parent, enableNaturalLanguageQueryUnderstanding=None, filter=None, orderBy=None, pageSize=None, pageToken=None, query=None, readMask=None, x__xgafv=None)

Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.

search_next()

@@ -15114,15 +15114,17 @@

Method Details

- search(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) + search(parent, enableNaturalLanguageQueryUnderstanding=None, filter=None, orderBy=None, pageSize=None, pageToken=None, query=None, readMask=None, x__xgafv=None)
Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.
 
 Args:
   parent: string, Required. The client, which owns this collection of Templates. (required)
+  enableNaturalLanguageQueryUnderstanding: boolean, Optional. Whether to enable natural language query understanding.
   filter: string, Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, "status=\"ACTIVE\"
   orderBy: string, Optional. The results would be returned in the order you specified here.
   pageSize: integer, Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. The token returned in the previous response.
+  query: string, Optional. The search query that will be passed to Vertex search service.
   readMask: string, Optional. The mask which specifies fields that need to be returned in the template's response.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html
index bef6be83ba..be6c62b5d1 100644
--- a/docs/dyn/looker_v1.projects.locations.instances.html
+++ b/docs/dyn/looker_v1.projects.locations.instances.html
@@ -216,7 +216,10 @@ 

Method Details

"serviceAttachments": [ # Optional. List of egress service attachment configurations. { # Service attachment configuration. "connectionStatus": "A String", # Output only. Connection status. - "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment. + "A String", + ], "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} }, ], @@ -449,7 +452,10 @@

Method Details

"serviceAttachments": [ # Optional. List of egress service attachment configurations. { # Service attachment configuration. "connectionStatus": "A String", # Output only. Connection status. - "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment. + "A String", + ], "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} }, ], @@ -618,7 +624,10 @@

Method Details

"serviceAttachments": [ # Optional. List of egress service attachment configurations. { # Service attachment configuration. "connectionStatus": "A String", # Output only. Connection status. - "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment. + "A String", + ], "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} }, ], @@ -756,7 +765,10 @@

Method Details

"serviceAttachments": [ # Optional. List of egress service attachment configurations. { # Service attachment configuration. "connectionStatus": "A String", # Output only. Connection status. - "localFqdn": "A String", # Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdn": "A String", # Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. + "localFqdns": [ # Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment. + "A String", + ], "targetServiceAttachmentUri": "A String", # Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment} }, ], diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html index 63f2084d42..8520dfc3c0 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html @@ -124,9 +124,9 @@

Method Details

"customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, @@ -136,9 +136,9 @@

Method Details

"koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, @@ -177,9 +177,9 @@

Method Details

"customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, @@ -189,9 +189,9 @@

Method Details

"koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, @@ -229,9 +229,9 @@

Method Details

"customerService": { # Customer service information. # Optional. The customer service of the business. "email": "A String", # Optional. The email address where customer service may be reached. "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, @@ -241,9 +241,9 @@

Method Details

"koreanBusinessRegistrationNumber": "A String", # Optional. The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business. - "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes + "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future. - "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code + "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (For example "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (For example: US and CA). # A short code. Reference(s): - https://wikipedia.org/wiki/Short_code "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code. For example "611". "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag }, diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.gbpAccounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.gbpAccounts.html index 03d3a91a5b..c7361d2a01 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.gbpAccounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.gbpAccounts.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Link the specified merchant to a GBP account for all countries.

+

Link the specified merchant to a GBP account for all countries. To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message `User is not an administrator of account {ACCOUNT_ID}`.

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

List the GBP accounts for a given merchant.

@@ -94,7 +94,7 @@

Method Details

linkGbpAccount(parent, body=None, x__xgafv=None) -
Link the specified merchant to a GBP account for all countries.
+  
Link the specified merchant to a GBP account for all countries. To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message `User is not an administrator of account {ACCOUNT_ID}`.
 
 Args:
   parent: string, Required. The name of the parent resource to which the GBP account is linked. Format: `accounts/{account}`. (required)
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
index 080abcc9b4..73a03ea7e5 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
@@ -173,7 +173,7 @@ 

Instance Methods

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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

-

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an advanced account, but all accounts the calling user has access to including other advanced accounts, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.

+

Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.

listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`

@@ -318,7 +318,7 @@

Method Details

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an advanced account, but all accounts the calling user has access to including other advanced accounts, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.
+  
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
 
 Args:
   filter: string, Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html
index 0948239160..8e72ee8927 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html
@@ -104,7 +104,7 @@ 

Method Details

An object of the form: { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. - "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag. + "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. { # Shipping service. @@ -422,7 +422,7 @@

Method Details

The object takes the form of: { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. - "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag. + "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. { # Shipping service. @@ -738,7 +738,7 @@

Method Details

An object of the form: { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. - "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag. + "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. { # Shipping service. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html index 5ceb485a74..d8d9b1996b 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html @@ -82,7 +82,7 @@

Instance Methods

Returns the state of a terms of service agreement.

retrieveForApplication(parent, x__xgafv=None)

-

Retrieves the state of the agreement for the application terms of service.

+

Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.

Method Details

close() @@ -104,28 +104,28 @@

Method Details

An object of the form: { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services, we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`. The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. - "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # The accepted terms of service of this kind and for the associated region_code - "acceptedBy": "A String", # The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. - "termsOfService": "A String", # The accepted termsOfService. - "validUntil": { # 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 # When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. + "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. + "termsOfService": "A String", # Required. The accepted termsOfService. + "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. "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. }, }, "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`. - "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. - "required": { # Describes the terms of service which are required to be accepted. # The required terms of service - "termsOfService": "A String", # The `TermsOfService` that need to be accepted. - "tosFileUri": "A String", # Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. + "regionCode": "A String", # Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. + "required": { # Describes the terms of service which are required to be accepted. # Optional. The required terms of service + "termsOfService": "A String", # Required. The `TermsOfService` that need to be accepted. + "tosFileUri": "A String", # Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. }, - "termsOfServiceKind": "A String", # Terms of Service kind associated with the particular version. + "termsOfServiceKind": "A String", # Required. Terms of Service kind associated with the particular version. }
retrieveForApplication(parent, x__xgafv=None) -
Retrieves the state of the agreement for the application terms of service.
+  
Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.
 
 Args:
   parent: string, Required. The account for which to get a TermsOfServiceAgreementState Format: `accounts/{account}` (required)
@@ -138,22 +138,22 @@ 

Method Details

An object of the form: { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services, we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`. The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. - "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # The accepted terms of service of this kind and for the associated region_code - "acceptedBy": "A String", # The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. - "termsOfService": "A String", # The accepted termsOfService. - "validUntil": { # 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 # When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. + "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. + "termsOfService": "A String", # Required. The accepted termsOfService. + "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. "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. }, }, "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`. - "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. - "required": { # Describes the terms of service which are required to be accepted. # The required terms of service - "termsOfService": "A String", # The `TermsOfService` that need to be accepted. - "tosFileUri": "A String", # Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. + "regionCode": "A String", # Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. + "required": { # Describes the terms of service which are required to be accepted. # Optional. The required terms of service + "termsOfService": "A String", # Required. The `TermsOfService` that need to be accepted. + "tosFileUri": "A String", # Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. }, - "termsOfServiceKind": "A String", # Terms of Service kind associated with the particular version. + "termsOfServiceKind": "A String", # Required. Terms of Service kind associated with the particular version. }
diff --git a/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html b/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html index ca63b63e07..c05eed2645 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html +++ b/docs/dyn/merchantapi_accounts_v1beta.termsOfService.html @@ -105,22 +105,22 @@

Method Details

{ # Response message for the `AcceptTermsOfService` method. "termsOfServiceAgreementState": { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services, we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`. The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. # The agreement state after accepting the ToS. - "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # The accepted terms of service of this kind and for the associated region_code - "acceptedBy": "A String", # The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. - "termsOfService": "A String", # The accepted termsOfService. - "validUntil": { # 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 # When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. + "accepted": { # Describes the [accepted terms of service](/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. + "termsOfService": "A String", # Required. The accepted termsOfService. + "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. "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. }, }, "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`. - "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. - "required": { # Describes the terms of service which are required to be accepted. # The required terms of service - "termsOfService": "A String", # The `TermsOfService` that need to be accepted. - "tosFileUri": "A String", # Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. + "regionCode": "A String", # Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. + "required": { # Describes the terms of service which are required to be accepted. # Optional. The required terms of service + "termsOfService": "A String", # Required. The `TermsOfService` that need to be accepted. + "tosFileUri": "A String", # Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. }, - "termsOfServiceKind": "A String", # Terms of Service kind associated with the particular version. + "termsOfServiceKind": "A String", # Required. Terms of Service kind associated with the particular version. }, }
diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index 9dd470e25c..5cb1685015 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -417,7 +417,7 @@

Method Details

}, ], "dataSource": "A String", # Output only. The primary data source of the product. - "feedLabel": "A String", # Output only. The feed label for the product. + "feedLabel": "A String", # Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087) "name": "A String", # The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123` "offerId": "A String", # Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [product data specification](https://support.google.com/merchants/answer/188494#id) for details. "productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. @@ -788,7 +788,7 @@

Method Details

}, ], "dataSource": "A String", # Output only. The primary data source of the product. - "feedLabel": "A String", # Output only. The feed label for the product. + "feedLabel": "A String", # Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087) "name": "A String", # The name of the product. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product name is `accounts/123/products/online~en~US~sku123` "offerId": "A String", # Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [product data specification](https://support.google.com/merchants/answer/188494#id) for details. "productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. diff --git a/docs/dyn/mybusinessaccountmanagement_v1.accounts.html b/docs/dyn/mybusinessaccountmanagement_v1.accounts.html index 6440c3f73b..45a8b34b58 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.accounts.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.accounts.html @@ -121,7 +121,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "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", ], @@ -162,7 +162,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "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", ], @@ -210,7 +210,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "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", ], @@ -263,7 +263,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "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", ], @@ -323,7 +323,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "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", ], @@ -366,7 +366,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html b/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html index deddd5f61c..14040b36cc 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.accounts.invitations.html @@ -165,7 +165,7 @@

Method Details

"accountNumber": "A String", # Output only. Account reference number if provisioned. "name": "A String", # Immutable. The resource name, in the format `accounts/{account_id}`. "organizationInfo": { # Additional information stored for an organization. # Output only. Additional info for an organization. This is populated only for an organization account. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Output only. The postal address for the account. + "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. # Output only. The postal address for the account. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html index 098f9354a8..b7e1382c44 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html @@ -305,7 +305,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -540,7 +540,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -787,7 +787,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index c5e9fb7ba2..1d8f051106 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -299,7 +299,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -538,7 +538,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html index 11aac4b394..03a7e38ea4 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html @@ -343,7 +343,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -627,7 +627,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -864,7 +864,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "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", ], @@ -1099,7 +1099,7 @@

Method Details

], }, "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records. - "storefrontAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. + "storefrontAddress": { # 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. # Optional. 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. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/mybusinessverifications_v1.locations.html b/docs/dyn/mybusinessverifications_v1.locations.html index 51a02cdc40..bdaedd5e91 100644 --- a/docs/dyn/mybusinessverifications_v1.locations.html +++ b/docs/dyn/mybusinessverifications_v1.locations.html @@ -108,7 +108,7 @@

Method Details

{ # Request message for Verifications.FetchVerificationOptions. "context": { # Additional data for service business verification. # Optional. Extra context information for the verification of service businesses. Can only be applied to the locations whose business type is CUSTOMER_LOCATION_ONLY. Specifying an accurate address could enable more options. INVALID_ARGUMENT will be thrown if it is set for other business types of locations. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The verification address of the location. It is used to either enable more verification options or send a postcard. + "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. # The verification address of the location. It is used to either enable more verification options or send a postcard. "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", ], @@ -141,7 +141,7 @@

Method Details

"options": [ # The available verification options. { # The verification option represents how to verify the location (indicated by verification method) and where the verification will be sent to (indicated by display data). "addressData": { # Display data for verifications through postcard. # Set only if the method is MAIL. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Address that a postcard can be sent to. + "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. # Address that a postcard can be sent to. "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", ], @@ -215,7 +215,7 @@

Method Details

{ # Request message for Verifications.VerifyLocation. "context": { # Additional data for service business verification. # Optional. Extra context information for the verification of service businesses. It is only required for the locations whose business type is CUSTOMER_LOCATION_ONLY. For ADDRESS verification, the address will be used to send out postcard. For other methods, it should be the same as the one that is passed to GetVerificationOptions. INVALID_ARGUMENT will be thrown if it is set for other types of business locations. - "address": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The verification address of the location. It is used to either enable more verification options or send a postcard. + "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. # The verification address of the location. It is used to either enable more verification options or send a postcard. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html index 1901089f7a..61bfc3ffe5 100644 --- a/docs/dyn/netapp_v1.projects.locations.storagePools.html +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html @@ -123,8 +123,10 @@

Method Details

"createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool + "enableHotTierAutoResize": True or False, # Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. "encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. + "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -232,8 +234,10 @@

Method Details

"createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool + "enableHotTierAutoResize": True or False, # Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. "encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. + "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -284,8 +288,10 @@

Method Details

"createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool + "enableHotTierAutoResize": True or False, # Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. "encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. + "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", @@ -343,8 +349,10 @@

Method Details

"createTime": "A String", # Output only. Create time of the storage pool "customPerformanceEnabled": True or False, # Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false "description": "A String", # Optional. Description of the storage pool + "enableHotTierAutoResize": True or False, # Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. "encryptionType": "A String", # Output only. Specifies the current pool encryption key source. "globalAccessAllowed": True or False, # Deprecated. Used to allow SO pool to access AD or DNS server from other regions. + "hotTierSizeGib": "A String", # Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for volume encryption. "labels": { # Optional. Labels as key value pairs "a_key": "A String", diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html index e1f68f0391..cbee481524 100644 --- a/docs/dyn/netapp_v1.projects.locations.volumes.html +++ b/docs/dyn/netapp_v1.projects.locations.volumes.html @@ -243,6 +243,7 @@

Method Details

"storagePool": "A String", # Required. StoragePool name of the volume "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only. @@ -445,6 +446,7 @@

Method Details

"storagePool": "A String", # Required. StoragePool name of the volume "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only. @@ -592,6 +594,7 @@

Method Details

"storagePool": "A String", # Required. StoragePool name of the volume "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only. @@ -740,6 +743,7 @@

Method Details

"storagePool": "A String", # Required. StoragePool name of the volume "tieringPolicy": { # Defines tiering policy for the volume. # Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "unixPermissions": "A String", # Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only. diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.replications.html b/docs/dyn/netapp_v1.projects.locations.volumes.replications.html index c558dc5d45..1b1d3af855 100644 --- a/docs/dyn/netapp_v1.projects.locations.volumes.replications.html +++ b/docs/dyn/netapp_v1.projects.locations.volumes.replications.html @@ -136,6 +136,7 @@

Method Details

"storagePool": "A String", # Required. Existing destination StoragePool name. "tieringPolicy": { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. @@ -310,6 +311,7 @@

Method Details

"storagePool": "A String", # Required. Existing destination StoragePool name. "tieringPolicy": { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. @@ -380,6 +382,7 @@

Method Details

"storagePool": "A String", # Required. Existing destination StoragePool name. "tieringPolicy": { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. @@ -457,6 +460,7 @@

Method Details

"storagePool": "A String", # Required. Existing destination StoragePool name. "tieringPolicy": { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume. "coolingThresholdDays": 42, # Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. + "hotTierBypassModeEnabled": True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. "tierAction": "A String", # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. }, "volumeId": "A String", # Desired destination volume resource id. If not specified, source volume's resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. diff --git a/docs/dyn/networkmanagement_v1.html b/docs/dyn/networkmanagement_v1.html index 14c9db65d1..211ae6aad6 100644 --- a/docs/dyn/networkmanagement_v1.html +++ b/docs/dyn/networkmanagement_v1.html @@ -74,6 +74,11 @@

Network Management API

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+

projects()

diff --git a/docs/dyn/networkmanagement_v1.organizations.html b/docs/dyn/networkmanagement_v1.organizations.html new file mode 100644 index 0000000000..11f9eda405 --- /dev/null +++ b/docs/dyn/networkmanagement_v1.organizations.html @@ -0,0 +1,91 @@ + + + +

Network Management API . organizations

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/networkmanagement_v1.organizations.locations.html b/docs/dyn/networkmanagement_v1.organizations.locations.html new file mode 100644 index 0000000000..627775554c --- /dev/null +++ b/docs/dyn/networkmanagement_v1.organizations.locations.html @@ -0,0 +1,177 @@ + + + +

Network Management API . organizations . locations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (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/networkmanagement_v1.organizations.locations.operations.html b/docs/dyn/networkmanagement_v1.organizations.locations.operations.html new file mode 100644 index 0000000000..5159a3de43 --- /dev/null +++ b/docs/dyn/networkmanagement_v1.organizations.locations.operations.html @@ -0,0 +1,235 @@ + + + +

Network Management API . organizations . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+}
+
+ +
+ 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/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 970df2f8b6..e5dc40da50 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -134,6 +134,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -366,8 +367,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -681,8 +683,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -851,6 +854,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -963,6 +967,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -1195,8 +1200,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1510,8 +1516,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1680,6 +1687,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -1783,6 +1791,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2015,8 +2024,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2330,8 +2340,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2500,6 +2511,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2562,6 +2574,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2794,8 +2807,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3109,8 +3123,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3279,6 +3294,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 6a3017e000..ba5e7a3f51 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -135,6 +135,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -367,8 +368,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -682,8 +684,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -853,6 +856,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -966,6 +970,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -1198,8 +1203,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1513,8 +1519,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -1684,6 +1691,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -1788,6 +1796,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2020,8 +2029,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2335,8 +2345,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -2506,6 +2517,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2569,6 +2581,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -2801,8 +2814,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3116,8 +3130,9 @@

Method Details

], "networkUri": "A String", # URI of a Compute Engine network. "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). - "running": True or False, # Indicates whether the Compute Engine instance is running. + "running": True or False, # Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead. "serviceAccount": "A String", # Service account authorized for the instance. + "status": "A String", # The status of the instance. "uri": "A String", # URI of a Compute Engine instance. }, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. @@ -3287,6 +3302,7 @@

Method Details

"uri": "A String", # A [Cloud Function](https://cloud.google.com/functions) name. }, "cloudRunRevision": { # Wrapper for Cloud Run revision attributes. # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. + "serviceUri": "A String", # Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service} "uri": "A String", # A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision} }, "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. diff --git a/docs/dyn/networksecurity_v1.projects.locations.backendAuthenticationConfigs.html b/docs/dyn/networksecurity_v1.projects.locations.backendAuthenticationConfigs.html new file mode 100644 index 0000000000..a58eeb20ec --- /dev/null +++ b/docs/dyn/networksecurity_v1.projects.locations.backendAuthenticationConfigs.html @@ -0,0 +1,328 @@ + + + +

Network Security API . projects . locations . backendAuthenticationConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new BackendAuthenticationConfig in a given project and location.

+

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

+

Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.

+

+ get(name, x__xgafv=None)

+

Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

+

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

+

Lists BackendAuthenticationConfigs in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backendAuthenticationConfigId=None, body=None, x__xgafv=None) +
Creates a new BackendAuthenticationConfig in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the BackendAuthenticationConfig. Must be in the format `projects/*/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.
+  "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Free-text description of the resource.
+  "etag": "A String", # Output only. Etag of the resource.
+  "labels": { # Set of label tags associated with the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
+  "trustConfig": "A String", # Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "wellKnownRoots": "A String", # Well known roots to use for server certificate validation.
+}
+
+  backendAuthenticationConfigId: string, Required. Short name of the BackendAuthenticationConfig 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. "backend-auth-config".
+  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 single BackendAuthenticationConfig to BackendAuthenticationConfig.
+
+Args:
+  name: string, Required. A name of the BackendAuthenticationConfig to delete. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`. (required)
+  etag: string, Optional. Etag of the resource. If this is provided, it must match the server's etag.
+  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 details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.
+
+Args:
+  name: string, Required. A name of the BackendAuthenticationConfig to get. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.
+  "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Free-text description of the resource.
+  "etag": "A String", # Output only. Etag of the resource.
+  "labels": { # Set of label tags associated with the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
+  "trustConfig": "A String", # Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "wellKnownRoots": "A String", # Well known roots to use for server certificate validation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists BackendAuthenticationConfigs in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the BackendAuthenticationConfigs should be listed, specified in the format `projects/*/locations/{location}`. (required)
+  pageSize: integer, Maximum number of BackendAuthenticationConfigs to return per call.
+  pageToken: string, The value returned by the last `ListBackendAuthenticationConfigsResponse` Indicates that this is a continuation of a prior `ListBackendAuthenticationConfigs` call, and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the ListBackendAuthenticationConfigs method.
+  "backendAuthenticationConfigs": [ # List of BackendAuthenticationConfig resources.
+    { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.
+      "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. Free-text description of the resource.
+      "etag": "A String", # Output only. Etag of the resource.
+      "labels": { # Set of label tags associated with the resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
+      "trustConfig": "A String", # Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+      "wellKnownRoots": "A String", # Well known roots to use for server certificate validation.
+    },
+  ],
+  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+  "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 the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.
+
+Args:
+  name: string, Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS.
+  "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Free-text description of the resource.
+  "etag": "A String", # Output only. Etag of the resource.
+  "labels": { # Set of label tags associated with the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`
+  "trustConfig": "A String", # Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+  "wellKnownRoots": "A String", # Well known roots to use for server certificate validation.
+}
+
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the BackendAuthenticationConfig 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
+      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/networksecurity_v1.projects.locations.html b/docs/dyn/networksecurity_v1.projects.locations.html index 3ccd3a922d..b1947f7b3c 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.html +++ b/docs/dyn/networksecurity_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the authzPolicies Resource.

+

+ backendAuthenticationConfigs() +

+

Returns the backendAuthenticationConfigs Resource.

+

clientTlsPolicies()

diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.sacAttachments.html b/docs/dyn/networksecurity_v1beta1.projects.locations.sacAttachments.html index c01162ea46..336bf19556 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.sacAttachments.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.sacAttachments.html @@ -82,10 +82,10 @@

Instance Methods

Creates a new SACAttachment in a given project and location.

delete(name, requestId=None, x__xgafv=None)

-

Deletes a single SACAttachment.

+

Deletes the specified attachment.

get(name, x__xgafv=None)

-

Gets details of a single SACAttachment.

+

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.

@@ -103,30 +103,30 @@

Method Details

Creates a new SACAttachment in a given project and location.
 
 Args:
-  parent: string, Required. Value for parent. (required)
+  parent: string, Required. The parent, in the form `projects/{project}/locations/{location}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configuration for an attachment within a SAC realm.
-  "country": "A String", # Optional. ISO-3166 alpha 2 country code used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Not case-sensitive, since it will be upper-cased when sending to Symantec API.
-  "createTime": "A String", # Output only. [Output only] Timestamp when the attachment was created.
+{ # Represents a Secure Access Connect (SAC) Attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product.
+  "country": "A String", # Optional. Case-insensitive ISO-3166 alpha-2 country code used for localization. Only valid for Symantec attachments.
+  "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. Name of the NCC Gateway which connects to the attachment. ID or full URI can be specified. Full URI is stored either way,in the form `projects/{project}/locations/{location}/spokes/{ncc_gateway}`.
-  "sacRealm": "A String", # Required. Name of the SAC Realm which owns the attachment. The input can be either an ID for a full name. The output will always be the full name using project number instead of project ID. The format is `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.
-  "state": "A String", # Output only. [Output only] State of the attachment.
-  "symantecOptions": { # Fields specific to SSEGWs connecting to Symantec Cloud SWG. # Optional. Required iff the associated realm is of type SYMANTEC_CLOUD_SWG.
-    "symantecLocationName": "A String", # Immutable. Name to be used for when creating a Location on the customer's behalf in Symantec's Location API. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. Not to be confused with GCP locations.
-    "symantecSite": "A String", # Immutable. Symantec data center identifier that this Attachment will connect to. Required iff sac_realm uses SYMANTEC_CLOUD_SWG.
+  "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.
+  "symantecOptions": { # Fields specific to attachments associated with Symantec Cloud SWG. # Optional. Configuration required for Symantec attachments.
+    "symantecLocationName": "A String", # Immutable. Name to be used when creating a location on the customer's behalf in Symantec's Location API. Not to be confused with GCP locations.
+    "symantecSite": "A String", # Immutable. Symantec data center identifier that this attachment will connect to.
   },
-  "timeZone": "A String", # Optional. tzinfo identifier used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Case sensitive.
-  "updateTime": "A String", # Output only. [Output only] Timestamp when the attachment was last updated.
+  "timeZone": "A String", # Optional. Case-sensitive tzinfo identifier used for localization. Only valid for Symantec attachments.
+  "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 requesting object If auto-generating Id server-side, remove this field and sac_attachment_id from the method_signature of Create RPC
+  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
@@ -158,10 +158,10 @@ 

Method Details

delete(name, requestId=None, x__xgafv=None) -
Deletes a single SACAttachment.
+  
Deletes the specified attachment.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  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
@@ -194,10 +194,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets details of a single SACAttachment.
+  
Returns the specified attachment.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  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
@@ -206,22 +206,22 @@ 

Method Details

Returns: An object of the form: - { # Configuration for an attachment within a SAC realm. - "country": "A String", # Optional. ISO-3166 alpha 2 country code used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Not case-sensitive, since it will be upper-cased when sending to Symantec API. - "createTime": "A String", # Output only. [Output only] Timestamp when the attachment was created. + { # Represents a Secure Access Connect (SAC) Attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product. + "country": "A String", # Optional. Case-insensitive ISO-3166 alpha-2 country code used for localization. Only valid for Symantec attachments. + "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. Name of the NCC Gateway which connects to the attachment. ID or full URI can be specified. Full URI is stored either way,in the form `projects/{project}/locations/{location}/spokes/{ncc_gateway}`. - "sacRealm": "A String", # Required. Name of the SAC Realm which owns the attachment. The input can be either an ID for a full name. The output will always be the full name using project number instead of project ID. The format is `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`. - "state": "A String", # Output only. [Output only] State of the attachment. - "symantecOptions": { # Fields specific to SSEGWs connecting to Symantec Cloud SWG. # Optional. Required iff the associated realm is of type SYMANTEC_CLOUD_SWG. - "symantecLocationName": "A String", # Immutable. Name to be used for when creating a Location on the customer's behalf in Symantec's Location API. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. Not to be confused with GCP locations. - "symantecSite": "A String", # Immutable. Symantec data center identifier that this Attachment will connect to. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. + "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. + "symantecOptions": { # Fields specific to attachments associated with Symantec Cloud SWG. # Optional. Configuration required for Symantec attachments. + "symantecLocationName": "A String", # Immutable. Name to be used when creating a location on the customer's behalf in Symantec's Location API. Not to be confused with GCP locations. + "symantecSite": "A String", # Immutable. Symantec data center identifier that this attachment will connect to. }, - "timeZone": "A String", # Optional. tzinfo identifier used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Case sensitive. - "updateTime": "A String", # Output only. [Output only] Timestamp when the attachment was last updated. + "timeZone": "A String", # Optional. Case-sensitive tzinfo identifier used for localization. Only valid for Symantec attachments. + "updateTime": "A String", # Output only. Timestamp when the attachment was last updated. }
@@ -230,9 +230,9 @@

Method Details

Lists SACAttachments in a given project and location.
 
 Args:
-  parent: string, Required. Parent value for ListSACAttachmentsRequest (required)
-  filter: string, Optional. Filtering results
-  orderBy: string, Optional. Hint for how to order the results
+  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.
@@ -243,25 +243,25 @@ 

Method Details

Returns: An object of the form: - { # Message for response to listing SACAttachments + { # Response for `ListSACAttachments` method. "nextPageToken": "A String", # A token identifying a page of results the server should return. - "sacAttachments": [ # The list of SACAttachments - { # Configuration for an attachment within a SAC realm. - "country": "A String", # Optional. ISO-3166 alpha 2 country code used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Not case-sensitive, since it will be upper-cased when sending to Symantec API. - "createTime": "A String", # Output only. [Output only] Timestamp when the attachment was created. + "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. + "country": "A String", # Optional. Case-insensitive ISO-3166 alpha-2 country code used for localization. Only valid for Symantec attachments. + "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. Name of the NCC Gateway which connects to the attachment. ID or full URI can be specified. Full URI is stored either way,in the form `projects/{project}/locations/{location}/spokes/{ncc_gateway}`. - "sacRealm": "A String", # Required. Name of the SAC Realm which owns the attachment. The input can be either an ID for a full name. The output will always be the full name using project number instead of project ID. The format is `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`. - "state": "A String", # Output only. [Output only] State of the attachment. - "symantecOptions": { # Fields specific to SSEGWs connecting to Symantec Cloud SWG. # Optional. Required iff the associated realm is of type SYMANTEC_CLOUD_SWG. - "symantecLocationName": "A String", # Immutable. Name to be used for when creating a Location on the customer's behalf in Symantec's Location API. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. Not to be confused with GCP locations. - "symantecSite": "A String", # Immutable. Symantec data center identifier that this Attachment will connect to. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. + "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. + "symantecOptions": { # Fields specific to attachments associated with Symantec Cloud SWG. # Optional. Configuration required for Symantec attachments. + "symantecLocationName": "A String", # Immutable. Name to be used when creating a location on the customer's behalf in Symantec's Location API. Not to be confused with GCP locations. + "symantecSite": "A String", # Immutable. Symantec data center identifier that this attachment will connect to. }, - "timeZone": "A String", # Optional. tzinfo identifier used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Case sensitive. - "updateTime": "A String", # Output only. [Output only] Timestamp when the attachment was last updated. + "timeZone": "A String", # Optional. Case-sensitive tzinfo identifier used for localization. Only valid for Symantec attachments. + "updateTime": "A String", # Output only. Timestamp when the attachment was last updated. }, ], "unreachable": [ # Locations that could not be reached. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.sacRealms.html b/docs/dyn/networksecurity_v1beta1.projects.locations.sacRealms.html index 06b318bd22..a4a6159c32 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.sacRealms.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.sacRealms.html @@ -82,10 +82,10 @@

Instance Methods

Creates a new SACRealm in a given project.

delete(name, requestId=None, x__xgafv=None)

-

Deletes a single SACRealm.

+

Deletes the specified realm.

get(name, x__xgafv=None)

-

Gets details of a single SACRealm.

+

Returns the specified realm.

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

Lists SACRealms in a given project.

@@ -103,34 +103,34 @@

Method Details

Creates a new SACRealm in a given project.
 
 Args:
-  parent: string, Required. Value for parent. (required)
+  parent: string, Required. The parent, in the form `projects/{project}/locations/global`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Message describing SACRealm object
-  "createTime": "A String", # Output only. [Output only] Create time stamp
-  "labels": { # Optional. Labels as key value pairs
+{ # 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. It matches the pattern `projects/{project}/locations/{location}/sacRealms/{sacRealm}`
-  "pairingKey": { # Key to be shared with SSE service provider to establish global handshake # Output only. [Output only] Key to be shared with SSE service provider to establish global handshake
-    "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired.
-    "key": "A String", # Output only. The name of the key. It expires 7 days after creation.
+  "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
-  "state": "A String", # Output only. [Output only] State of the realm
-  "symantecOptions": { # Fields specific to realms using SYMANTEC_CLOUD_SWG. # Optional. Required only if using SYMANTEC_CLOUD_SWG.
-    "availableSymantecSites": [ # Output only. Symantec site IDs that the user can choose to connect to.
+  "securityService": "A String", # Immutable. SSE service provider associated with the realm.
+  "state": "A String", # Output only. State of the realm.
+  "symantecOptions": { # Fields specific to realms using Symantec Cloud SWG. # Optional. Configuration required for Symantec realms.
+    "availableSymantecSites": [ # Output only. Symantec site IDs which the user can choose to connect to.
       "A String",
     ],
-    "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using SYMANTEC_CLOUD_SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as secret URI in the format of "projects/{PROJECT_NUMBER}/secrets/my-secret".
-    "symantecConnectionState": "A String", # Output only. [Output only] Connection status to Symantec API.
+    "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using Symantec Cloud SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as a secret URI in the form `projects/{project_number}/secrets/my-secret`.
+    "symantecConnectionState": "A String", # Output only. Connection status to Symantec API.
   },
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "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 requesting object If auto-generating Id server-side, remove this field and sac_realm_id from the method_signature of Create RPC
+  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
@@ -162,10 +162,10 @@ 

Method Details

delete(name, requestId=None, x__xgafv=None) -
Deletes a single SACRealm.
+  
Deletes the specified realm.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  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
@@ -198,10 +198,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets details of a single SACRealm.
+  
Returns the specified realm.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  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
@@ -210,26 +210,26 @@ 

Method Details

Returns: An object of the form: - { # Message describing SACRealm object - "createTime": "A String", # Output only. [Output only] Create time stamp - "labels": { # Optional. Labels as key value pairs + { # 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. It matches the pattern `projects/{project}/locations/{location}/sacRealms/{sacRealm}` - "pairingKey": { # Key to be shared with SSE service provider to establish global handshake # Output only. [Output only] Key to be shared with SSE service provider to establish global handshake - "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. - "key": "A String", # Output only. The name of the key. It expires 7 days after creation. + "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 - "state": "A String", # Output only. [Output only] State of the realm - "symantecOptions": { # Fields specific to realms using SYMANTEC_CLOUD_SWG. # Optional. Required only if using SYMANTEC_CLOUD_SWG. - "availableSymantecSites": [ # Output only. Symantec site IDs that the user can choose to connect to. + "securityService": "A String", # Immutable. SSE service provider associated with the realm. + "state": "A String", # Output only. State of the realm. + "symantecOptions": { # Fields specific to realms using Symantec Cloud SWG. # Optional. Configuration required for Symantec realms. + "availableSymantecSites": [ # Output only. Symantec site IDs which the user can choose to connect to. "A String", ], - "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using SYMANTEC_CLOUD_SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as secret URI in the format of "projects/{PROJECT_NUMBER}/secrets/my-secret". - "symantecConnectionState": "A String", # Output only. [Output only] Connection status to Symantec API. + "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using Symantec Cloud SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as a secret URI in the form `projects/{project_number}/secrets/my-secret`. + "symantecConnectionState": "A String", # Output only. Connection status to Symantec API. }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Timestamp when the realm was last updated. }
@@ -238,9 +238,9 @@

Method Details

Lists SACRealms in a given project.
 
 Args:
-  parent: string, Required. Parent value for ListSACRealmsRequest (required)
-  filter: string, Optional. Filtering results
-  orderBy: string, Optional. Hint for how to order the results
+  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.
@@ -251,29 +251,29 @@ 

Method Details

Returns: An object of the form: - { # Message for response to listing SACRealms + { # Response for `ListSACRealms` method. "nextPageToken": "A String", # A token identifying a page of results the server should return. - "sacRealms": [ # The list of SACRealms - { # Message describing SACRealm object - "createTime": "A String", # Output only. [Output only] Create time stamp - "labels": { # Optional. Labels as key value pairs + "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. It matches the pattern `projects/{project}/locations/{location}/sacRealms/{sacRealm}` - "pairingKey": { # Key to be shared with SSE service provider to establish global handshake # Output only. [Output only] Key to be shared with SSE service provider to establish global handshake - "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. - "key": "A String", # Output only. The name of the key. It expires 7 days after creation. + "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 - "state": "A String", # Output only. [Output only] State of the realm - "symantecOptions": { # Fields specific to realms using SYMANTEC_CLOUD_SWG. # Optional. Required only if using SYMANTEC_CLOUD_SWG. - "availableSymantecSites": [ # Output only. Symantec site IDs that the user can choose to connect to. + "securityService": "A String", # Immutable. SSE service provider associated with the realm. + "state": "A String", # Output only. State of the realm. + "symantecOptions": { # Fields specific to realms using Symantec Cloud SWG. # Optional. Configuration required for Symantec realms. + "availableSymantecSites": [ # Output only. Symantec site IDs which the user can choose to connect to. "A String", ], - "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using SYMANTEC_CLOUD_SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as secret URI in the format of "projects/{PROJECT_NUMBER}/secrets/my-secret". - "symantecConnectionState": "A String", # Output only. [Output only] Connection status to Symantec API. + "secretPath": "A String", # Optional. API Key used to call Symantec APIs on the user's behalf. Required if using Symantec Cloud SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as a secret URI in the form `projects/{project_number}/secrets/my-secret`. + "symantecConnectionState": "A String", # Output only. Connection status to Symantec API. }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Timestamp when the realm was last updated. }, ], "unreachable": [ # Locations that could not be reached. diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index e9a80f5900..b3c534c38d 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -94,7 +94,7 @@

Instance Methods

Gets details of a single Instance.

getConfig(name, x__xgafv=None)

-

Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.

+

Returns various configuration parameters.

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.

@@ -548,7 +548,7 @@

Method Details

getConfig(name, x__xgafv=None) -
Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.
+  
Returns various configuration parameters.
 
 Args:
   name: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
diff --git a/docs/dyn/orgpolicy_v2.folders.policies.html b/docs/dyn/orgpolicy_v2.folders.policies.html
index 7f793010e1..6f440b8d12 100644
--- a/docs/dyn/orgpolicy_v2.folders.policies.html
+++ b/docs/dyn/orgpolicy_v2.folders.policies.html
@@ -130,7 +130,7 @@ 

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -161,7 +161,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -193,7 +193,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -236,7 +236,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -267,7 +267,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -299,7 +299,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -368,7 +368,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -399,7 +399,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -431,7 +431,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -481,7 +481,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -512,7 +512,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -544,7 +544,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -599,7 +599,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -630,7 +630,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -662,7 +662,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -723,7 +723,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -754,7 +754,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -786,7 +786,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -830,7 +830,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -861,7 +861,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -893,7 +893,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/orgpolicy_v2.organizations.policies.html b/docs/dyn/orgpolicy_v2.organizations.policies.html index 3bc4bfa386..ecbeeaa125 100644 --- a/docs/dyn/orgpolicy_v2.organizations.policies.html +++ b/docs/dyn/orgpolicy_v2.organizations.policies.html @@ -130,7 +130,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -161,7 +161,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -193,7 +193,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -236,7 +236,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -267,7 +267,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -299,7 +299,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -368,7 +368,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -399,7 +399,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -431,7 +431,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -481,7 +481,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -512,7 +512,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -544,7 +544,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -599,7 +599,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -630,7 +630,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -662,7 +662,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -723,7 +723,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -754,7 +754,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -786,7 +786,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -830,7 +830,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -861,7 +861,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -893,7 +893,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/orgpolicy_v2.projects.policies.html b/docs/dyn/orgpolicy_v2.projects.policies.html index e383117f54..b7f53381ae 100644 --- a/docs/dyn/orgpolicy_v2.projects.policies.html +++ b/docs/dyn/orgpolicy_v2.projects.policies.html @@ -130,7 +130,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -161,7 +161,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -193,7 +193,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -236,7 +236,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -267,7 +267,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -299,7 +299,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -368,7 +368,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -399,7 +399,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -431,7 +431,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -481,7 +481,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -512,7 +512,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -544,7 +544,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -599,7 +599,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -630,7 +630,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -662,7 +662,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -723,7 +723,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -754,7 +754,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -786,7 +786,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -830,7 +830,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -861,7 +861,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -893,7 +893,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index fbddc3b7a7..61a549194b 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -336,7 +336,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -372,7 +372,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -381,7 +381,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -417,7 +417,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -597,7 +597,7 @@

Method Details

"compoundCode": "A String", # Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity. "globalCode": "A String", # Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters). }, - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. "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", ], @@ -638,7 +638,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -674,7 +674,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -683,7 +683,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -719,7 +719,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -928,7 +928,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -964,7 +964,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -973,7 +973,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1009,7 +1009,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1189,7 +1189,7 @@

Method Details

"compoundCode": "A String", # Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity. "globalCode": "A String", # Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters). }, - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. "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", ], @@ -1230,7 +1230,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1266,7 +1266,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1275,7 +1275,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1311,7 +1311,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1650,7 +1650,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1686,7 +1686,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1695,7 +1695,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1731,7 +1731,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1911,7 +1911,7 @@

Method Details

"compoundCode": "A String", # Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity. "globalCode": "A String", # Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters). }, - "postalAddress": { # Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. + "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # The address in postal address format. "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", ], @@ -1952,7 +1952,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -1988,7 +1988,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, @@ -1997,7 +1997,7 @@

Method Details

"nextCloseTime": "A String", # The next time the current opening hours period ends up to 7 days in the future. This field is only populated if the opening hours period is active at the time of serving the request. "nextOpenTime": "A String", # The next time the current opening hours period starts up to 7 days in the future. This field is only populated if the opening hours period is not active at the time of serving the request. "openNow": True or False, # Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. - "periods": [ # The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. + "periods": [ # NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. { # A period the place remains in open_now status. "close": { # Status changing points. # The time that the place starts to be closed. "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 # Date in the local timezone for the place. @@ -2033,7 +2033,7 @@

Method Details

}, }, ], - "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" + "weekdayDescriptions": [ # Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00" "A String", ], }, diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html index bd72bf5c2b..bd8962ac8f 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html @@ -159,7 +159,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -190,7 +190,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -222,7 +222,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -343,7 +343,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -374,7 +374,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -406,7 +406,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -503,7 +503,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -534,7 +534,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, @@ -566,7 +566,7 @@

Method Details

"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. }, "denyAll": True or False, # Setting this to true means that all values are denied. This field can be set only in policies for list constraints. - "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. + "enforce": True or False, # If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints. "parameters": { # Optional. Required for managed constraints if parameters are defined. Passes parameter values when policy enforcement is enabled. Ensure that parameter value types match those defined in the constraint definition. For example: { "allowedLocations" : ["us-east1", "us-west1"], "allowAll" : true } "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html index eee3b17607..0439c6705e 100644 --- a/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html +++ b/docs/dyn/readerrevenuesubscriptionlinking_v1.publications.readers.html @@ -131,6 +131,9 @@

Method Details

{ # A reader of a publication. "createTime": "A String", # Output only. Time the publication reader was created and associated with a Google user. "name": "A String", # Output only. The resource name of the reader. The last part of ppid in the resource name is the publisher provided id. + "originatingPublicationId": "A String", # Output only. The SwG publication id that the reader's subscription linking was originating from. + "ppid": "A String", # Output only. The publisher provided id of the reader. + "publicationId": "A String", # Output only. The SwG publication id that the reader has linked their subscription to. }
diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index d80fa2d8fc..9da07c566d 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -76,7 +76,7 @@

reCAPTCHA Enterprise API . Instance Methods

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

-

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

+

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

close()

Close httplib2 connections.

@@ -119,7 +119,7 @@

Instance Methods

Method Details

addIpOverride(name, body=None, x__xgafv=None) -
Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
+  
Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
 
 Args:
   name: string, Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`. (required)
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html
index 0d5c6d2da0..02e09071e8 100644
--- a/docs/dyn/redis_v1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1.projects.locations.clusters.html
@@ -197,7 +197,7 @@ 

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -305,7 +305,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -456,7 +456,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -564,7 +564,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -681,7 +681,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -789,7 +789,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -889,7 +889,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -997,7 +997,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index 8baeb1bd34..eabdf9bf8d 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -197,7 +197,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -305,7 +305,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -456,7 +456,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -564,7 +564,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -681,7 +681,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -789,7 +789,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -889,7 +889,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. @@ -997,7 +997,7 @@

Method Details

"connectionType": "A String", # Output only. Type of the PSC connection. "forwardingRule": "A String", # Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. "network": "A String", # Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. - "port": 42, # Output only. The port number of the exposed discovery endpoint. + "port": 42, # Output only. port will only be set for Primary/Reader or Discovery endpoint. "projectId": "A String", # Optional. Project ID of the consumer project where the forwarding rule is created in. "pscConnectionId": "A String", # Required. The PSC connection id of the forwarding rule connected to the service attachment. "pscConnectionStatus": "A String", # Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index 3a713cb2b1..3d105df509 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -144,6 +144,9 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, + "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. } @@ -497,6 +500,7 @@

Method Details

"mode": "A String", # Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset. }, "entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. + "experimentId": "A String", # Optional. An ID for the experiment group this search belongs to. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html index 0ab7c71817..751bd6a368 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html @@ -237,6 +237,9 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. }, + "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + "a_key": "A String", + }, "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. } @@ -1048,6 +1051,7 @@

Method Details

"mode": "A String", # Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset. }, "entity": "A String", # The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. + "experimentId": "A String", # Optional. An ID for the experiment group this search belongs to. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 21188d0d57..d7612e9467 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -386,7 +386,7 @@

Method Details

], "index": 42, # Required. Index of the task, unique per execution, and beginning at 0. "lastAttemptResult": { # Result of a task attempt. # Optional. Result of the last attempt of this task. - "exitCode": 42, # Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. + "exitCode": 42, # Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set. "status": { # 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). # Optional. The status of this attempt. If the status code is OK, then the attempt succeeded. "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. @@ -396,6 +396,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "termSignal": 42, # Optional. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set. }, "logUri": "A String", # Optional. URI where logs for this task can be found in Cloud Console. "observedGeneration": 42, # Optional. The 'generation' of the task that was last processed by the controller. @@ -712,7 +713,7 @@

Method Details

], "index": 42, # Required. Index of the task, unique per execution, and beginning at 0. "lastAttemptResult": { # Result of a task attempt. # Optional. Result of the last attempt of this task. - "exitCode": 42, # Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. + "exitCode": 42, # Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set. "status": { # 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). # Optional. The status of this attempt. If the status code is OK, then the attempt succeeded. "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. @@ -722,6 +723,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "termSignal": 42, # Optional. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set. }, "logUri": "A String", # Optional. URI where logs for this task can be found in Cloud Console. "observedGeneration": 42, # Optional. The 'generation' of the task that was last processed by the controller. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index 7bbad4cc75..d8e6aea75b 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -236,7 +236,7 @@

Method Details

"a_key": "A String", }, "lastAttemptResult": { # Result of a task attempt. # Output only. Result of the last attempt of this Task. - "exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. + "exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set. "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of this attempt. If the status code is OK, then the attempt succeeded. "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. @@ -246,6 +246,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "termSignal": 42, # Output only. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set. }, "logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console. "maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed. @@ -466,7 +467,7 @@

Method Details

"a_key": "A String", }, "lastAttemptResult": { # Result of a task attempt. # Output only. Result of the last attempt of this Task. - "exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. + "exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set. "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The status of this attempt. If the status code is OK, then the attempt succeeded. "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. @@ -476,6 +477,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "termSignal": 42, # Output only. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set. }, "logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console. "maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index bec3605b39..b51d33e0cc 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -301,7 +301,6 @@

Method Details

"serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity. "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number. }, - "sessionAffinity": True or False, # Optional. Enable session affinity. "volumes": [ # Optional. A list of Volumes to make available to containers. { # Volume represents a named volume in a container. "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. @@ -626,7 +625,6 @@

Method Details

"serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity. "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number. }, - "sessionAffinity": True or False, # Optional. Enable session affinity. "volumes": [ # Optional. A list of Volumes to make available to containers. { # Volume represents a named volume in a container. "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. @@ -938,7 +936,6 @@

Method Details

"serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity. "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number. }, - "sessionAffinity": True or False, # Optional. Enable session affinity. "volumes": [ # Optional. A list of Volumes to make available to containers. { # Volume represents a named volume in a container. "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. @@ -1207,7 +1204,6 @@

Method Details

"serviceMesh": { # Settings for Cloud Service Mesh. For more information see https://cloud.google.com/service-mesh/docs/overview. # Optional. Enables service mesh connectivity. "mesh": "A String", # The Mesh resource name. Format: `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can be project id or number. }, - "sessionAffinity": True or False, # Optional. Enable session affinity. "volumes": [ # Optional. A list of Volumes to make available to containers. { # Volume represents a named volume in a container. "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index a66af1e4b8..3675bc47ea 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1232,6 +1241,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index d445c2ae8b..3098f1617a 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -215,6 +215,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -801,6 +810,21 @@

Method Details

"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 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 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 @@ -981,6 +1005,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1567,6 +1600,21 @@

Method Details

"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 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 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 @@ -1661,6 +1709,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2247,6 +2304,21 @@

Method Details

"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 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 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 @@ -2354,6 +2426,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2940,6 +3021,21 @@

Method Details

"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 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 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 @@ -3048,6 +3144,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -3634,6 +3739,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 50969a9168..fff10c6d63 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1232,6 +1241,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 534915cc93..4879668cd5 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -148,6 +148,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -734,6 +743,21 @@

Method Details

"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 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 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 @@ -828,6 +852,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1414,6 +1447,21 @@

Method Details

"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 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 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 @@ -1579,6 +1627,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2165,6 +2222,21 @@

Method Details

"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 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 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 @@ -2345,6 +2417,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2931,6 +3012,21 @@

Method Details

"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 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 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 @@ -3025,6 +3121,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -3611,6 +3716,21 @@

Method Details

"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 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 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 @@ -3718,6 +3838,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -4304,6 +4433,21 @@

Method Details

"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 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 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 @@ -4412,6 +4556,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -4998,6 +5151,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index ea189b317c..828e020631 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -646,6 +646,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1232,6 +1241,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index c561f199fb..efe6e21484 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -215,6 +215,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -801,6 +810,21 @@

Method Details

"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 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 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 @@ -981,6 +1005,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -1567,6 +1600,21 @@

Method Details

"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 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 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 @@ -1661,6 +1709,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2247,6 +2304,21 @@

Method Details

"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 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 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 @@ -2354,6 +2426,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -2940,6 +3021,21 @@

Method Details

"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 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 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 @@ -3048,6 +3144,15 @@

Method Details

"affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. "count": "A String", # The count of resources affected by the finding. }, + "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”. + }, "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`. @@ -3634,6 +3739,21 @@

Method Details

"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 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 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 diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index f683349789..500129d23d 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -2650,6 +2650,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -3698,6 +3713,21 @@

Method Details

}, "repeatCell": { # Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing. # Repeats a single cell across a range. "cell": { # Data about a specific cell. # The data to write. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -4933,6 +4963,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -14242,6 +14287,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -17980,6 +18040,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -21711,6 +21786,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -25452,6 +25542,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. @@ -29229,6 +29334,21 @@

Method Details

{ # Data about each cell in a row. "values": [ # The values in the row, one per column. { # Data about a specific cell. + "chipRuns": [ # Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an “@” placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs. + { # The run of a chip. The chip continues until the start index of the next run. + "chip": { # The Smart Chip. # Optional. The chip of this run. + "personProperties": { # Properties specific to a linked person. # Properties of a linked person. + "displayFormat": "A String", # Optional. The display format of the person chip. If not set, the default display format is used. + "email": "A String", # Required. The email address linked to this person. This field is always present. + }, + "richLinkProperties": { # Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes. # Properties of a rich link. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive). + "uri": "A String", # Required. The URI to the link. This is always present. + }, + }, + "startIndex": 42, # Required. The zero-based character index where this run starts, in UTF-16 code units. + }, + ], "dataSourceFormula": { # A data source formula. # Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`. "dataExecutionStatus": { # The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. # Output only. The data execution status. "errorCode": "A String", # The error code. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 55536a9f3c..02bb2ad188 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -139,6 +139,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -268,6 +271,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -338,6 +344,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -410,6 +419,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index 3a57839fd7..9538745c5a 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -139,6 +139,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -270,6 +273,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -342,6 +348,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -416,6 +425,9 @@

Method Details

"domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. + "gatewayConfig": { # Configuration options for Cluster HTTP Gateway. # Optional. Configuration options for Cluster HTTP Gateway. + "http2Enabled": True or False, # Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. + }, "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json index cedf342199..68399481fc 100644 --- a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json +++ b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json @@ -151,7 +151,7 @@ } } }, -"revision": "20250330", +"revision": "20250611", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -769,7 +769,7 @@ "type": "object" }, "GoogleTypePostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "GoogleTypePostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json index 492e360b72..e048d7c260 100644 --- a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json @@ -181,6 +181,31 @@ "resources": { "sites": { "methods": { +"get": { +"description": "Gets a Platform Child Site for a specified Platform Child Account and site.", +"flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/childAccounts/{childAccountsId}/sites/{sitesId}", +"httpMethod": "GET", +"id": "adsenseplatform.accounts.platforms.childAccounts.sites.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the platform child site to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}", +"location": "path", +"pattern": "^accounts/[^/]+/platforms/[^/]+/childAccounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "PlatformChildSite" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, "list": { "description": "Lists Platform Child Sites for a specified Platform Child Account.", "flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/childAccounts/{childAccountsId}/sites", @@ -258,6 +283,31 @@ }, "groups": { "methods": { +"get": { +"description": "Gets a Platform Group for a specified Platform and group.", +"flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/groups/{groupsId}", +"httpMethod": "GET", +"id": "adsenseplatform.accounts.platforms.groups.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the platform group to retrieve. Format: accounts/{account}/platforms/{platform}/groups/{group}", +"location": "path", +"pattern": "^accounts/[^/]+/platforms/[^/]+/groups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "PlatformGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, "list": { "description": "Lists Platform Groups for a specified Platform.", "flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/groups", @@ -639,7 +689,7 @@ } } }, -"revision": "20250123", +"revision": "20250612", "rootUrl": "https://adsenseplatform.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 4abd0be028..a54cb8db4f 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -20167,7 +20167,7 @@ } } }, -"revision": "20250529", +"revision": "20250602", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -34442,10 +34442,14 @@ false "type": "string" }, "thought": { -"description": "Output only. Indicates if the part is thought from the model.", -"readOnly": true, +"description": "Optional. Indicates if the part is thought from the model.", "type": "boolean" }, +"thoughtSignature": { +"description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", +"format": "byte", +"type": "string" +}, "videoMetadata": { "$ref": "GoogleCloudAiplatformV1VideoMetadata", "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." @@ -45007,6 +45011,10 @@ false "$ref": "GoogleCloudAiplatformV1ToolCodeExecution", "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, +"computerUse": { +"$ref": "GoogleCloudAiplatformV1ToolComputerUse", +"description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations." +}, "enterpriseWebSearch": { "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." @@ -45029,6 +45037,10 @@ false "retrieval": { "$ref": "GoogleCloudAiplatformV1Retrieval", "description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." +}, +"urlContext": { +"$ref": "GoogleCloudAiplatformV1UrlContext", +"description": "Optional. Tool to support URL context retrieval." } }, "type": "object" @@ -45121,6 +45133,25 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1ToolComputerUse": { +"description": "Tool to support computer use.", +"id": "GoogleCloudAiplatformV1ToolComputerUse", +"properties": { +"environment": { +"description": "Required. The environment being operated.", +"enum": [ +"ENVIRONMENT_UNSPECIFIED", +"ENVIRONMENT_BROWSER" +], +"enumDescriptions": [ +"Defaults to browser.", +"Operates in a web browser." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "id": "GoogleCloudAiplatformV1ToolConfig", @@ -46610,6 +46641,12 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1UrlContext": { +"description": "Tool to support URL context.", +"id": "GoogleCloudAiplatformV1UrlContext", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "id": "GoogleCloudAiplatformV1UserActionReference", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 1bc5890f0a..7f36e10d41 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -19013,6 +19013,120 @@ } }, "resources": { +"examples": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/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" +] +} +} +} +} +}, "memories": { "resources": { "operations": { @@ -24319,7 +24433,7 @@ } } }, -"revision": "20250529", +"revision": "20250602", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -41421,10 +41535,14 @@ false "type": "string" }, "thought": { -"description": "Output only. Indicates if the part is thought from the model.", -"readOnly": true, +"description": "Optional. Indicates if the part is thought from the model.", "type": "boolean" }, +"thoughtSignature": { +"description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", +"format": "byte", +"type": "string" +}, "videoMetadata": { "$ref": "GoogleCloudAiplatformV1beta1VideoMetadata", "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." @@ -53316,6 +53434,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution", "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, +"computerUse": { +"$ref": "GoogleCloudAiplatformV1beta1ToolComputerUse", +"description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations." +}, "enterpriseWebSearch": { "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." @@ -53338,6 +53460,10 @@ false "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", "description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." +}, +"urlContext": { +"$ref": "GoogleCloudAiplatformV1beta1UrlContext", +"description": "Optional. Tool to support URL context retrieval." } }, "type": "object" @@ -53430,6 +53556,25 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1beta1ToolComputerUse": { +"description": "Tool to support computer use.", +"id": "GoogleCloudAiplatformV1beta1ToolComputerUse", +"properties": { +"environment": { +"description": "Required. The environment being operated.", +"enum": [ +"ENVIRONMENT_UNSPECIFIED", +"ENVIRONMENT_BROWSER" +], +"enumDescriptions": [ +"Defaults to browser.", +"Operates in a web browser." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "id": "GoogleCloudAiplatformV1beta1ToolConfig", @@ -54533,6 +54678,16 @@ false "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "serviceAccount": { "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -55070,6 +55225,12 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1UrlContext": { +"description": "Tool to support URL context.", +"id": "GoogleCloudAiplatformV1beta1UrlContext", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "id": "GoogleCloudAiplatformV1beta1UserActionReference", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index be73c6983a..76b5aa083a 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1622,7 +1622,7 @@ } } }, -"revision": "20250529", +"revision": "20250605", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2946,7 +2946,7 @@ false "id": "InstanceNetworkConfig", "properties": { "allocatedIpRangeOverride": { -"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", +"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", "type": "string" }, "authorizedExternalNetworks": { @@ -4124,7 +4124,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "feedTimestamp": { @@ -4625,7 +4625,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5434,6 +5434,7 @@ false "type": "string" }, "timeBasedRetention": { +"deprecated": true, "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 84ac9eeb62..3e067b0d17 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1622,7 +1622,7 @@ } } }, -"revision": "20250529", +"revision": "20250605", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2127,7 +2127,7 @@ false "description": "Cross Region replication config specific to SECONDARY cluster." }, "serviceAccountEmail": { -"description": "Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change.", +"description": "Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change.", "readOnly": true, "type": "string" }, @@ -3106,7 +3106,7 @@ false "id": "InstanceNetworkConfig", "properties": { "allocatedIpRangeOverride": { -"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", +"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", "type": "string" }, "authorizedExternalNetworks": { @@ -4292,7 +4292,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "feedTimestamp": { @@ -4793,7 +4793,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5602,6 +5602,7 @@ false "type": "string" }, "timeBasedRetention": { +"deprecated": true, "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 1203b835d7..23fe1f407b 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1619,7 +1619,7 @@ } } }, -"revision": "20250529", +"revision": "20250605", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2108,7 +2108,7 @@ false "description": "Cross Region replication config specific to SECONDARY cluster." }, "serviceAccountEmail": { -"description": "Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change.", +"description": "Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change.", "readOnly": true, "type": "string" }, @@ -3082,7 +3082,7 @@ false "id": "InstanceNetworkConfig", "properties": { "allocatedIpRangeOverride": { -"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", +"description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", "type": "string" }, "authorizedExternalNetworks": { @@ -4268,7 +4268,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "feedTimestamp": { @@ -4769,7 +4769,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5578,6 +5578,7 @@ false "type": "string" }, "timeBasedRetention": { +"deprecated": true, "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 42a56673d6..69a7ee0c47 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -5041,11 +5041,112 @@ ] } } +}, +"subpropertySyncConfigs": { +"methods": { +"get": { +"description": "Lookup for a single Subproperty Sync Config.", +"flatPath": "v1alpha/properties/{propertiesId}/subpropertySyncConfigs/{subpropertySyncConfigsId}", +"httpMethod": "GET", +"id": "analyticsadmin.properties.subpropertySyncConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678", +"location": "path", +"pattern": "^properties/[^/]+/subpropertySyncConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"list": { +"description": "List all Subproperty Sync Configs on a property.", +"flatPath": "v1alpha/properties/{propertiesId}/subpropertySyncConfigs", +"httpMethod": "GET", +"id": "analyticsadmin.properties.subpropertySyncConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Resource name of the property. Format: properties/property_id Example: properties/123", +"location": "path", +"pattern": "^properties/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/subpropertySyncConfigs", +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"patch": { +"description": "Updates a Subproperty Sync Config.", +"flatPath": "v1alpha/properties/{propertiesId}/subpropertySyncConfigs/{subpropertySyncConfigsId}", +"httpMethod": "PATCH", +"id": "analyticsadmin.properties.subpropertySyncConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678", +"location": "path", +"pattern": "^properties/[^/]+/subpropertySyncConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig" +}, +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +} +} } } } }, -"revision": "20250329", +"revision": "20250606", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6440,6 +6541,10 @@ "skadnetworkConversionValueSchema": { "$ref": "GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema", "description": "A snapshot of SKAdNetworkConversionValueSchema resource in change history." +}, +"subpropertySyncConfig": { +"$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig", +"description": "A snapshot of a SubpropertySyncConfig resource in change history." } }, "type": "object" @@ -8370,6 +8475,24 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse": { +"description": "Response message for ListSubpropertySyncConfigs RPC.", +"id": "GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse", +"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" +}, +"subpropertySyncConfigs": { +"description": "List of Subproperty Sync Configs.", +"items": { +"$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1alphaMatchingCondition": { "description": "Defines a condition for when an Event Edit or Event Creation rule applies to an event.", "id": "GoogleAnalyticsAdminV1alphaMatchingCondition", @@ -8712,6 +8835,20 @@ "description": "Request message for CreateSubproperty RPC.", "id": "GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest", "properties": { +"customDimensionAndMetricSynchronizationMode": { +"description": "Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics", +"enum": [ +"SYNCHRONIZATION_MODE_UNSPECIFIED", +"NONE", +"ALL" +], +"enumDescriptions": [ +"Synchronization mode unknown or not specified.", +"Entities are not synchronized. Local edits are allowed on the Subproperty.", +"Entities are synchronized from Parent Property. Local mutations are not allowed on the Subproperty (Create / Update / Delete)" +], +"type": "string" +}, "subproperty": { "$ref": "GoogleAnalyticsAdminV1alphaProperty", "description": "Required. The subproperty to create." @@ -9094,7 +9231,8 @@ "EVENT_CREATE_RULE", "KEY_EVENT", "CALCULATED_METRIC", -"REPORTING_DATA_ANNOTATION" +"REPORTING_DATA_ANNOTATION", +"SUBPROPERTY_SYNC_CONFIG" ], "enumDescriptions": [ "Resource type unknown or not specified.", @@ -9124,7 +9262,8 @@ "EventCreateRule resource", "KeyEvent resource", "CalculatedMetric resource", -"ReportingDataAnnotation resource" +"ReportingDataAnnotation resource", +"SubpropertySyncConfig resource" ], "type": "string" }, @@ -9309,6 +9448,37 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1alphaSubpropertySyncConfig": { +"description": "Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.", +"id": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig", +"properties": { +"applyToProperty": { +"description": "Output only. Immutable. Resource name of the Subproperty that these settings apply to.", +"readOnly": true, +"type": "string" +}, +"customDimensionAndMetricSyncMode": { +"description": "Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.", +"enum": [ +"SYNCHRONIZATION_MODE_UNSPECIFIED", +"NONE", +"ALL" +], +"enumDescriptions": [ +"Synchronization mode unknown or not specified.", +"Entities are not synchronized. Local edits are allowed on the Subproperty.", +"Entities are synchronized from Parent Property. Local mutations are not allowed on the Subproperty (Create / Update / Delete)" +], +"type": "string" +}, +"name": { +"description": "Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest": { "description": "Request message for UpdateAccessBinding RPC.", "id": "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest", diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 20a46b8ffc..1404f6767f 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -469,7 +469,7 @@ ] }, "generateEnterpriseUpgradeUrl": { -"description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.", +"description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl", "httpMethod": "POST", "id": "androidenterprise.enterprises.generateEnterpriseUpgradeUrl", @@ -2691,7 +2691,7 @@ } } }, -"revision": "20250330", +"revision": "20250610", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3515,7 +3515,7 @@ "type": "object" }, "GenerateEnterpriseUpgradeUrlResponse": { -"description": "Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.", +"description": "Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.", "id": "GenerateEnterpriseUpgradeUrlResponse", "properties": { "url": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index d2b29fbed4..912af4d7f3 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -173,7 +173,7 @@ ] }, "generateEnterpriseUpgradeUrl": { -"description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.", +"description": "Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide (https://developers.google.com/android/management/upgrade-an-enterprise) for more details.", "flatPath": "v1/enterprises/{enterprisesId}:generateEnterpriseUpgradeUrl", "httpMethod": "POST", "id": "androidmanagement.enterprises.generateEnterpriseUpgradeUrl", @@ -1204,7 +1204,7 @@ } } }, -"revision": "20250603", +"revision": "20250610", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 8b86cfe2c9..3e55a24757 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -2435,7 +2435,7 @@ "type": "string" }, "rows": { -"description": "Optional. Maximum number of app IDs to return. Defaults to 10000.", +"description": "Optional. Maximum number of app IDs to return. Defaults to 1000.", "format": "int64", "location": "query", "type": "string" @@ -11063,7 +11063,7 @@ } } }, -"revision": "20250519", +"revision": "20250614", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -16466,6 +16466,10 @@ "readOnly": true, "type": "string" }, +"networkEgressRestricted": { +"description": "Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`.", +"type": "boolean" +}, "portalDisabled": { "description": "Optional. Configuration for the Portals settings.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index fe11c1ccef..62e2ca4b22 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1711,6 +1711,274 @@ } }, "resources": { +"authorizedCertificates": { +"methods": { +"create": { +"description": "Uploads the specified SSL certificate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "POST", +"id": "appengine.projects.locations.applications.authorizedCertificates.create", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified SSL certificate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.authorizedCertificates.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the specified SSL certificate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.get", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the GET response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists all SSL certificates the user is authorized to administer.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.list", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum results to return per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Continuation token for fetching the next page of results.", +"location": "query", +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the LIST response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"response": { +"$ref": "ListAuthorizedCertificatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.authorizedCertificates.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "authorizedDomains": { "methods": { "list": { @@ -2051,7 +2319,7 @@ } } }, -"revision": "20250512", +"revision": "20250611", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 9107c18a11..db74234c62 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -803,6 +803,274 @@ "resources": { "applications": { "resources": { +"authorizedCertificates": { +"methods": { +"create": { +"description": "Uploads the specified SSL certificate.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "POST", +"id": "appengine.projects.locations.applications.authorizedCertificates.create", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified SSL certificate.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.authorizedCertificates.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the specified SSL certificate.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.get", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the GET response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists all SSL certificates the user is authorized to administer.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.list", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum results to return per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Continuation token for fetching the next page of results.", +"location": "query", +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the LIST response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"response": { +"$ref": "ListAuthorizedCertificatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.authorizedCertificates.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "authorizedDomains": { "methods": { "list": { @@ -1009,7 +1277,7 @@ } } }, -"revision": "20250512", +"revision": "20250611", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 8b3541a992..06db201c00 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1824,6 +1824,274 @@ } }, "resources": { +"authorizedCertificates": { +"methods": { +"create": { +"description": "Uploads the specified SSL certificate.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "POST", +"id": "appengine.projects.locations.applications.authorizedCertificates.create", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified SSL certificate.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "DELETE", +"id": "appengine.projects.locations.applications.authorizedCertificates.delete", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the specified SSL certificate.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.get", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the GET response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists all SSL certificates the user is authorized to administer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"httpMethod": "GET", +"id": "appengine.projects.locations.applications.authorizedCertificates.list", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId" +], +"parameters": { +"applicationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `parent`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum results to return per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Continuation token for fetching the next page of results.", +"location": "query", +"type": "string" +}, +"projectsId": { +"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "Controls the set of fields returned in the LIST response.", +"enum": [ +"BASIC_CERTIFICATE", +"FULL_CERTIFICATE" +], +"enumDescriptions": [ +"Basic certificate information, including applicable domains and expiration date.", +"The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates", +"response": { +"$ref": "ListAuthorizedCertificatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/appengine.admin", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.authorizedCertificates.patch", +"parameterOrder": [ +"projectsId", +"locationsId", +"applicationsId", +"authorizedCertificatesId" +], +"parameters": { +"applicationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"authorizedCertificatesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"locationsId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}", +"request": { +"$ref": "AuthorizedCertificate" +}, +"response": { +"$ref": "AuthorizedCertificate" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "authorizedDomains": { "methods": { "list": { @@ -2257,7 +2525,7 @@ } } }, -"revision": "20250512", +"revision": "20250611", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 1b0291aa5d..a552aea507 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -684,7 +684,7 @@ } } }, -"revision": "20250529", +"revision": "20250605", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -871,7 +871,9 @@ "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", -"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS" +"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", +"REGIONAL_DATA_BOUNDARY", +"JAPAN_DATA_BOUNDARY" ], "enumDeprecated": [ false, @@ -892,13 +894,15 @@ true, true, true, true, -false, true, -false, true, true, true, true, +true, +true, +false, +false, false, false, false, @@ -961,7 +965,9 @@ false "Data Boundary for US Regions and Support", "Data Boundary for US Healthcare and Life Sciences", "Data Boundary for US Healthcare and Life Sciences with Support", -"KSA Data Boundary with Access Justifications" +"KSA Data Boundary with Access Justifications", +"Regional Data Boundary", +"JAPAN Data Boundary" ], "type": "string" }, @@ -1564,7 +1570,9 @@ false "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", -"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS" +"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", +"REGIONAL_DATA_BOUNDARY", +"JAPAN_DATA_BOUNDARY" ], "enumDeprecated": [ false, @@ -1585,13 +1593,15 @@ true, true, true, true, -false, true, -false, true, true, true, true, +true, +true, +false, +false, false, false, false, @@ -1654,7 +1664,9 @@ false "Data Boundary for US Regions and Support", "Data Boundary for US Healthcare and Life Sciences", "Data Boundary for US Healthcare and Life Sciences with Support", -"KSA Data Boundary with Access Justifications" +"KSA Data Boundary with Access Justifications", +"Regional Data Boundary", +"JAPAN Data Boundary" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 44073da575..fd1c83b10c 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -656,7 +656,7 @@ } } }, -"revision": "20250529", +"revision": "20250605", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -843,7 +843,9 @@ "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", -"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS" +"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", +"REGIONAL_DATA_BOUNDARY", +"JAPAN_DATA_BOUNDARY" ], "enumDeprecated": [ false, @@ -864,13 +866,15 @@ true, true, true, true, -false, true, -false, true, true, true, true, +true, +true, +false, +false, false, false, false, @@ -933,7 +937,9 @@ false "Data Boundary for US Regions and Support", "Data Boundary for US Healthcare and Life Sciences", "Data Boundary for US Healthcare and Life Sciences with Support", -"KSA Data Boundary with Access Justifications" +"KSA Data Boundary with Access Justifications", +"Regional Data Boundary", +"JAPAN Data Boundary" ], "type": "string" }, @@ -1534,7 +1540,9 @@ false "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", -"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS" +"KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", +"REGIONAL_DATA_BOUNDARY", +"JAPAN_DATA_BOUNDARY" ], "enumDeprecated": [ false, @@ -1555,13 +1563,15 @@ true, true, true, true, -false, true, -false, true, true, true, true, +true, +true, +false, +false, false, false, false, @@ -1624,7 +1634,9 @@ false "Data Boundary for US Regions and Support", "Data Boundary for US Healthcare and Life Sciences", "Data Boundary for US Healthcare and Life Sciences with Support", -"KSA Data Boundary with Access Justifications" +"KSA Data Boundary with Access Justifications", +"Regional Data Boundary", +"JAPAN Data Boundary" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index e3695c2ce5..09ebf891fb 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -528,6 +528,112 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Update a BackupPlan", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupPlans.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan 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 the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackupPlan" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"revisions": { +"methods": { +"get": { +"description": "Gets details of a single BackupPlanRevision.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the `BackupPlanRevision` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackupPlanRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackupPlanRevisions in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Cloud BackupDR, locations map to GCP regions, for e.g. **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/revisions", +"response": { +"$ref": "ListBackupPlanRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -1795,7 +1901,7 @@ } } }, -"revision": "20250523", +"revision": "20250605", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2676,6 +2782,16 @@ "description": "Required. ", "type": "string" }, +"revisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"revisionName": { +"description": "Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`", +"readOnly": true, +"type": "string" +}, "state": { "description": "Output only. The `State` for the `BackupPlan`.", "enum": [ @@ -2722,6 +2838,16 @@ "description": "Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", "type": "string" }, +"backupPlanRevisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"backupPlanRevisionName": { +"description": "Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`", +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. The time when the instance was created.", "format": "google-datetime", @@ -2784,6 +2910,52 @@ }, "type": "object" }, +"BackupPlanRevision": { +"description": "`BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.", +"id": "BackupPlanRevision", +"properties": { +"backupPlanSnapshot": { +"$ref": "BackupPlan", +"description": "The Backup Plan being encompassed by this revision." +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`", +"readOnly": true, +"type": "string" +}, +"revisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. Resource State", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"INACTIVE" +], +"enumDescriptions": [ +"State not set.", +"The resource is being created.", +"The resource has been created and is fully usable.", +"The resource is being deleted.", +"The resource has been created but is not usable." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "BackupRule": { "description": "`BackupRule` binds the backup schedule to a retention policy.", "id": "BackupRule", @@ -3830,6 +4002,14 @@ "description": "Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", "type": "string" }, +"backupPlanRevisionId": { +"description": "The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.", +"type": "string" +}, +"backupPlanRevisionName": { +"description": "Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}", +"type": "string" +}, "backupPlanRuleId": { "description": "The rule id of the backup plan which triggered this backup in case of scheduled backup or used for", "type": "string" @@ -3853,6 +4033,14 @@ "description": "The description of the backup plan.", "type": "string" }, +"backupPlanRevisionId": { +"description": "The user friendly id of the backup plan revision. E.g. v0, v1 etc.", +"type": "string" +}, +"backupPlanRevisionName": { +"description": "The name of the backup plan revision.", +"type": "string" +}, "backupPlanRules": { "description": "The names of the backup plan rules which point to this backupvault", "items": { @@ -4035,6 +4223,31 @@ }, "type": "object" }, +"ListBackupPlanRevisionsResponse": { +"description": "The response message for getting a list of `BackupPlanRevision`.", +"id": "ListBackupPlanRevisionsResponse", +"properties": { +"backupPlanRevisions": { +"description": "The list of `BackupPlanRevisions` in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "BackupPlanRevision" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token which may be sent as page_token in a subsequent `ListBackupPlanRevisions` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListBackupPlansResponse": { "description": "The response message for getting a list of `BackupPlan`.", "id": "ListBackupPlansResponse", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index d9ee326f54..81deb5685c 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -109,108 +109,6 @@ "resources": { "locations": { "resources": { -"global": { -"resources": { -"partnerTenants": { -"methods": { -"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/global/partnerTenants/{partnerTenantsId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"browserDlpRules": { -"methods": { -"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/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"proxyConfigs": { -"methods": { -"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/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -} -} -}, "operations": { "methods": { "cancel": { @@ -1323,160 +1221,6 @@ } } }, -"clientConnectorServices": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy", -"httpMethod": "GET", -"id": "beyondcorp.projects.locations.clientConnectorServices.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientConnectorServices.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" -}, -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientConnectorServices.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"clientGateways": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy", -"httpMethod": "GET", -"id": "beyondcorp.projects.locations.clientGateways.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientGateways.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "global": { "resources": { "securityGateways": { @@ -2167,7 +1911,7 @@ } } }, -"revision": "20250409", +"revision": "20250604", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3528,7 +3272,7 @@ "type": "object" }, "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway": { -"description": "Information about a BeyoncCorp SecurityGateway resource.", +"description": "Information about a BeyondCorp SecurityGateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index a40fab828d..d223c1756c 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -214,100 +214,6 @@ "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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.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/global/partnerTenants/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"browserDlpRules": { -"methods": { -"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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.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/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"proxyConfigs": { -"methods": { -"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": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.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/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} } } } @@ -2009,160 +1915,6 @@ } } }, -"clientConnectorServices": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy", -"httpMethod": "GET", -"id": "beyondcorp.projects.locations.clientConnectorServices.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientConnectorServices.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:setIamPolicy", -"request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" -}, -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientConnectorServices.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"clientGateways": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy", -"httpMethod": "GET", -"id": "beyondcorp.projects.locations.clientGateways.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions", -"httpMethod": "POST", -"id": "beyondcorp.projects.locations.clientGateways.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "connections": { "methods": { "create": { @@ -3692,7 +3444,7 @@ } } }, -"revision": "20250409", +"revision": "20250604", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5868,7 +5620,7 @@ "type": "object" }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway": { -"description": "Information about a BeyoncCorp SecurityGateway resource.", +"description": "Information about a BeyondCorp SecurityGateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway", "properties": { "createTime": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index 4b200989ad..e591123c83 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -24,11 +24,36 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, { "description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west8.rep.googleapis.com/", "location": "europe-west8" }, @@ -1463,7 +1488,7 @@ } } }, -"revision": "20250423", +"revision": "20250603", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index f1ee2afd93..3173f7f825 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1526,7 +1526,7 @@ } } }, -"revision": "20250529", +"revision": "20250608", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2263,7 +2263,7 @@ "Default value. Unspecified.", "A user opens a dialog.", "A user clicks an interactive element of a dialog. For example, a user fills out information in a dialog and clicks a button to submit the information.", -"" +"A user closes a dialog without submitting information. The Chat app only receives this interaction event when users click the close icon in the top right corner of the dialog. When the user closes the dialog by other means (such as refreshing the browser, clicking outside the dialog box, or pressing the escape key), no event is sent." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index cef11d0085..47cbd0ab84 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1280,7 +1280,7 @@ } } }, -"revision": "20250605", +"revision": "20250612", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -2823,13 +2823,15 @@ false "STATE_UNSPECIFIED", "UNKNOWN", "ONLINE", -"OFFLINE" +"OFFLINE", +"DEVICE_OUTDATED" ], "enumDescriptions": [ "State not specified", "Device is not eligible for heartbeat monitoring", "Device is online", -"Device is offline" +"Device is offline", +"Device is outdated" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 9dd0754aed..68edaf986d 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2573,7 +2573,7 @@ } } }, -"revision": "20250521", +"revision": "20250609", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -5860,7 +5860,7 @@ false "id": "WorkerConfig", "properties": { "diskSizeGb": { -"description": "Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 2000. If `0` is specified, Cloud Build will use a standard disk size.", +"description": "Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size.", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 62e66343c0..108a5c2921 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, -"revision": "20250302", +"revision": "20250606", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -2030,6 +2030,14 @@ "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.", "id": "Project", "properties": { +"configuredCapabilities": { +"description": "Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Creation time. Read-only.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index 265adeb1c6..c8c4ca1708 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -568,7 +568,7 @@ } } }, -"revision": "20250302", +"revision": "20250606", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -1097,6 +1097,14 @@ "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.", "id": "Project", "properties": { +"configuredCapabilities": { +"description": "Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Creation time. Read-only.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 1df8b41d22..e800d10599 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -697,11 +697,11 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"patch": { -"description": "Updates tag bindings directly attached to a GCP resource. Update_mask can be kept empty or \"*\".", +"update": { +"description": "Updates tag bindings directly attached to a GCP resource.", "flatPath": "v3/locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}", -"httpMethod": "PATCH", -"id": "cloudresourcemanager.locations.tagBindingCollections.patch", +"httpMethod": "PUT", +"id": "cloudresourcemanager.locations.tagBindingCollections.update", "parameterOrder": [ "name" ], @@ -712,12 +712,6 @@ "pattern": "^locations/[^/]+/tagBindingCollections/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Optional. An update mask to selectively update fields.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v3/{+name}", @@ -1968,7 +1962,7 @@ } } }, -"revision": "20250522", +"revision": "20250606", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -2816,6 +2810,14 @@ "description": "A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.", "id": "Project", "properties": { +"configuredCapabilities": { +"description": "Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. Creation time.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 10ba707eba..e0c6a97798 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, -"revision": "20250602", +"revision": "20250609", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1348,47 +1348,6 @@ } }, "type": "object" -}, -"WorkflowOperationMetadata": { -"description": "Metadata about the operation. Used to lookup the current status.", -"id": "WorkflowOperationMetadata", -"properties": { -"namespace": { -"description": "The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved.", -"type": "string" -}, -"operationAction": { -"description": "The type of action the operation is classified as.", -"enum": [ -"OPERATION_ACTION_UNSPECIFIED", -"CREATE_SUPPORT_ACCOUNT", -"UPDATE_SUPPORT_ACCOUNT", -"PURCHASE_SUPPORT_ACCOUNT" -], -"enumDescriptions": [ -"Operation action is not specified.", -"Operation pertains to the creation of a new support account.", -"Operation pertains to the updating of an existing support account.", -"Operation pertains to the purchasing of a support plan that may either create or update a support account." -], -"type": "string" -}, -"workflowOperationType": { -"description": "Which version of the workflow service this operation came from.", -"enum": [ -"UNKNOWN_OPERATION_TYPE", -"WORKFLOWS_V1", -"WORKFLOWS_V2" -], -"enumDescriptions": [ -"Unknown version.", -"Version 1.", -"Version 2." -], -"type": "string" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index b927cbaeff..8fef4e5d4e 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -619,7 +619,7 @@ } } }, -"revision": "20250602", +"revision": "20250609", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1570,47 +1570,6 @@ } }, "type": "object" -}, -"WorkflowOperationMetadata": { -"description": "Metadata about the operation. Used to lookup the current status.", -"id": "WorkflowOperationMetadata", -"properties": { -"namespace": { -"description": "The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved.", -"type": "string" -}, -"operationAction": { -"description": "The type of action the operation is classified as.", -"enum": [ -"OPERATION_ACTION_UNSPECIFIED", -"CREATE_SUPPORT_ACCOUNT", -"UPDATE_SUPPORT_ACCOUNT", -"PURCHASE_SUPPORT_ACCOUNT" -], -"enumDescriptions": [ -"Operation action is not specified.", -"Operation pertains to the creation of a new support account.", -"Operation pertains to the updating of an existing support account.", -"Operation pertains to the purchasing of a support plan that may either create or update a support account." -], -"type": "string" -}, -"workflowOperationType": { -"description": "Which version of the workflow service this operation came from.", -"enum": [ -"UNKNOWN_OPERATION_TYPE", -"WORKFLOWS_V1", -"WORKFLOWS_V2" -], -"enumDescriptions": [ -"Unknown version.", -"Version 1.", -"Version 2." -], -"type": "string" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 9b3ca2bc51..5343cba3c9 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -50429,7 +50429,7 @@ } } }, -"revision": "20250601", +"revision": "20250603", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55783,7 +55783,7 @@ false "asns": { "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", "items": { -"format": "int32", +"format": "uint32", "type": "integer" }, "type": "array" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 9bfbd85df2..1ea79ba13a 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -45654,7 +45654,7 @@ } } }, -"revision": "20250601", +"revision": "20250603", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -50769,7 +50769,7 @@ false "asns": { "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", "items": { -"format": "int32", +"format": "uint32", "type": "integer" }, "type": "array" diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 9219077946..06effb729b 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -39884,7 +39884,7 @@ } } }, -"revision": "20250601", +"revision": "20250603", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44661,7 +44661,7 @@ false "asns": { "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", "items": { -"format": "int32", +"format": "uint32", "type": "integer" }, "type": "array" diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 52dfd80ddb..856922dcce 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1111,6 +1111,158 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"resourceChanges": { +"methods": { +"get": { +"description": "Get a ResourceChange for a given preview.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges/{resourceChangesId}", +"httpMethod": "GET", +"id": "config.projects.locations.previews.resourceChanges.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource change to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+/resourceChanges/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ResourceChange" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ResourceChanges for a given preview.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges", +"httpMethod": "GET", +"id": "config.projects.locations.previews.resourceChanges.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/previews/dep/resourceChanges/baz", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field to use to sort the list.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. When requesting a page of resource changes, 'page_size' specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Token returned by previous call to 'ListResourceChanges' which specifies the position in the list from where to continue listing the resource changes.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent in whose context the ResourceChanges are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/resourceChanges", +"response": { +"$ref": "ListResourceChangesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"resourceDrifts": { +"methods": { +"get": { +"description": "Get a ResourceDrift for a given preview.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts/{resourceDriftsId}", +"httpMethod": "GET", +"id": "config.projects.locations.previews.resourceDrifts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource drift to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+/resourceDrifts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ResourceDrift" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "List ResourceDrifts for a given preview.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts", +"httpMethod": "GET", +"id": "config.projects.locations.previews.resourceDrifts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Lists the resource drifts that match the filter expression. A filter expression filters the resource drifts listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/previews/dep/resourceDrifts/baz", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field to use to sort the list.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. When requesting a page of resource drifts, 'page_size' specifies number of resource drifts to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Token returned by previous call to 'ListResourceDrifts' which specifies the position in the list from where to continue listing the resource drifts.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent in whose context the ResourceDrifts are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/resourceDrifts", +"response": { +"$ref": "ListResourceDriftsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "terraformVersions": { @@ -1193,7 +1345,7 @@ } } }, -"revision": "20250528", +"revision": "20250604", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -1730,6 +1882,56 @@ }, "type": "object" }, +"ListResourceChangesResponse": { +"description": "A response to a 'ListResourceChanges' call. Contains a list of ResourceChanges.", +"id": "ListResourceChangesResponse", +"properties": { +"nextPageToken": { +"description": "A token to request the next page of resources from the 'ListResourceChanges' method. The value of an empty string means that there are no more resources to return.", +"type": "string" +}, +"resourceChanges": { +"description": "List of ResourceChanges.", +"items": { +"$ref": "ResourceChange" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListResourceDriftsResponse": { +"description": "A response to a 'ListResourceDrifts' call. Contains a list of ResourceDrifts.", +"id": "ListResourceDriftsResponse", +"properties": { +"nextPageToken": { +"description": "A token to request the next page of resources from the 'ListResourceDrifts' method. The value of an empty string means that there are no more resources to return.", +"type": "string" +}, +"resourceDrifts": { +"description": "List of ResourceDrifts.", +"items": { +"$ref": "ResourceDrift" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable resources, if any.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListResourcesResponse": { "description": "A response to a 'ListResources' call. Contains a list of Resources.", "id": "ListResourcesResponse", @@ -2238,6 +2440,82 @@ }, "type": "object" }, +"PropertyChange": { +"description": "A property change represents a change to a property in the state file.", +"id": "PropertyChange", +"properties": { +"after": { +"description": "Output only. Representations of the object value after the actions.", +"readOnly": true, +"type": "any" +}, +"afterSensitivePaths": { +"description": "Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"before": { +"description": "Output only. Representations of the object value before the actions.", +"readOnly": true, +"type": "any" +}, +"beforeSensitivePaths": { +"description": "Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"path": { +"description": "Output only. The path of the property change.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PropertyDrift": { +"description": "A property drift represents a drift to a property in the state file.", +"id": "PropertyDrift", +"properties": { +"after": { +"description": "Output only. Representations of the object value after the actions.", +"readOnly": true, +"type": "any" +}, +"afterSensitivePaths": { +"description": "Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"before": { +"description": "Output only. Representations of the object value before the actions.", +"readOnly": true, +"type": "any" +}, +"beforeSensitivePaths": { +"description": "Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"path": { +"description": "Output only. The path of the property drift.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Resource": { "description": "Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions.", "id": "Resource", @@ -2314,6 +2592,137 @@ }, "type": "object" }, +"ResourceChange": { +"description": "A resource change represents a change to a resource in the state file.", +"id": "ResourceChange", +"properties": { +"intent": { +"description": "Output only. The intent of the resource change.", +"enum": [ +"INTENT_UNSPECIFIED", +"CREATE", +"UPDATE", +"DELETE", +"RECREATE", +"UNCHANGED" +], +"enumDescriptions": [ +"The default value.", +"The resource will be created.", +"The resource will be updated.", +"The resource will be deleted.", +"The resource will be recreated.", +"The resource will be untouched." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The name of the resource change. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.", +"type": "string" +}, +"propertyChanges": { +"description": "Output only. The property changes of the resource change.", +"items": { +"$ref": "PropertyChange" +}, +"readOnly": true, +"type": "array" +}, +"terraformInfo": { +"$ref": "ResourceChangeTerraformInfo", +"description": "Output only. Terraform info of the resource change.", +"readOnly": true +} +}, +"type": "object" +}, +"ResourceChangeTerraformInfo": { +"description": "Terraform info of a ResourceChange.", +"id": "ResourceChangeTerraformInfo", +"properties": { +"actions": { +"description": "Output only. TF resource actions.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"address": { +"description": "Output only. TF resource address that uniquely identifies the resource.", +"readOnly": true, +"type": "string" +}, +"provider": { +"description": "Output only. TF resource provider.", +"readOnly": true, +"type": "string" +}, +"resourceName": { +"description": "Output only. TF resource name.", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. TF resource type.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ResourceDrift": { +"description": "A resource drift represents a drift to a resource in the state file.", +"id": "ResourceDrift", +"properties": { +"name": { +"description": "Identifier. The name of the resource drift. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.", +"type": "string" +}, +"propertyDrifts": { +"description": "Output only. The property drifts of the resource drift.", +"items": { +"$ref": "PropertyDrift" +}, +"readOnly": true, +"type": "array" +}, +"terraformInfo": { +"$ref": "ResourceDriftTerraformInfo", +"description": "Output only. Terraform info of the resource drift.", +"readOnly": true +} +}, +"type": "object" +}, +"ResourceDriftTerraformInfo": { +"description": "Terraform info of a ResourceChange.", +"id": "ResourceDriftTerraformInfo", +"properties": { +"address": { +"description": "Output only. The address of the drifted resource.", +"readOnly": true, +"type": "string" +}, +"provider": { +"description": "Output only. The provider of the drifted resource.", +"readOnly": true, +"type": "string" +}, +"resourceName": { +"description": "Output only. TF resource name.", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type of the drifted resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ResourceTerraformInfo": { "description": "Terraform info of a Resource.", "id": "ResourceTerraformInfo", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index db68d40ee1..98fe6bcaf7 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -176,13 +176,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -253,7 +253,7 @@ ] }, "create": { -"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", +"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "id": "container.projects.locations.clusters.create", @@ -304,13 +304,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -377,13 +377,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -436,13 +436,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -513,7 +513,7 @@ }, "setLocations": { "deprecated": true, -"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", +"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLocations", @@ -882,13 +882,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -961,13 +961,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1004,13 +1004,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1247,13 +1247,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1284,13 +1284,13 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1325,13 +1325,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1367,13 +1367,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1408,13 +1408,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1432,7 +1432,7 @@ ] }, "create": { -"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", +"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "id": "container.projects.zones.clusters.create", @@ -1442,13 +1442,13 @@ ], "parameters": { "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1488,13 +1488,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1561,13 +1561,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1599,13 +1599,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1638,13 +1638,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1660,7 +1660,7 @@ }, "locations": { "deprecated": true, -"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", +"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "id": "container.projects.zones.clusters.locations", @@ -1677,13 +1677,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1718,13 +1718,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1759,13 +1759,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1800,13 +1800,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1841,13 +1841,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1882,13 +1882,13 @@ "type": "string" }, "projectId": { -"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", +"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", +"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", "location": "path", "required": true, "type": "string" @@ -1923,13 +1923,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1964,13 +1964,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2005,13 +2005,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2046,13 +2046,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2098,13 +2098,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2139,13 +2139,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2192,13 +2192,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2272,13 +2272,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2315,13 +2315,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2360,13 +2360,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2408,13 +2408,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2456,13 +2456,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2504,13 +2504,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2551,13 +2551,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2597,13 +2597,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2633,13 +2633,13 @@ "type": "string" }, "projectId": { -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2660,7 +2660,7 @@ } } }, -"revision": "20250513", +"revision": "20250603", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2673,7 +2673,7 @@ "type": "string" }, "acceleratorType": { -"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", +"description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)", "type": "string" }, "gpuDriverInstallationConfig": { @@ -2691,6 +2691,24 @@ }, "type": "object" }, +"AdditionalIPRangesConfig": { +"description": "AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster", +"id": "AdditionalIPRangesConfig", +"properties": { +"podIpv4RangeNames": { +"description": "List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2", +"items": { +"type": "string" +}, +"type": "array" +}, +"subnetwork": { +"description": "Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet", +"type": "string" +} +}, +"type": "object" +}, "AdditionalNodeNetworkConfig": { "description": "AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message", "id": "AdditionalNodeNetworkConfig", @@ -2798,7 +2816,7 @@ "kubernetesDashboard": { "$ref": "KubernetesDashboard", "deprecated": true, -"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards" +"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards" }, "networkPolicyConfig": { "$ref": "NetworkPolicyConfig", @@ -2885,7 +2903,22 @@ "AnonymousAuthenticationConfig": { "description": "AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication.", "id": "AnonymousAuthenticationConfig", -"properties": {}, +"properties": { +"mode": { +"description": "Defines the mode of limiting anonymous access in the cluster.", +"enum": [ +"MODE_UNSPECIFIED", +"ENABLED", +"LIMITED" +], +"enumDescriptions": [ +"Default value not specified.", +"Anonymous authentication is allowed for all endpoints.", +"Anonymous authentication is allowed for only health check endpoints." +], +"type": "string" +} +}, "type": "object" }, "AuthenticatorGroupsConfig": { @@ -2903,6 +2936,12 @@ }, "type": "object" }, +"AutoIpamConfig": { +"description": "AutoIpamConfig contains all information related to Auto IPAM", +"id": "AutoIpamConfig", +"properties": {}, +"type": "object" +}, "AutoMonitoringConfig": { "description": "AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.", "id": "AutoMonitoringConfig", @@ -3019,7 +3058,7 @@ "id": "AutoprovisioningNodePoolDefaults", "properties": { "bootDiskKmsKey": { -"description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", +"description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", "type": "string" }, "diskSizeGb": { @@ -3032,7 +3071,7 @@ "type": "string" }, "imageType": { -"description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", +"description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "insecureKubeletReadonlyPortEnabled": { @@ -3045,7 +3084,7 @@ }, "minCpuPlatform": { "deprecated": true, -"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", +"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "oauthScopes": { @@ -3207,12 +3246,12 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -3386,7 +3425,7 @@ }, "currentNodeVersion": { "deprecated": true, -"description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", "readOnly": true, "type": "string" }, @@ -3437,6 +3476,10 @@ "$ref": "Fleet", "description": "Fleet information for the cluster." }, +"gkeAutoUpgradeConfig": { +"$ref": "GkeAutoUpgradeConfig", +"description": "Configuration for GKE auto upgrades." +}, "id": { "description": "Output only. Unique id for the cluster.", "readOnly": true, @@ -3452,7 +3495,7 @@ }, "initialNodeCount": { "deprecated": true, -"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") 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. This field is deprecated, use node_pool.initial_node_count instead.", +"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") 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. This field is deprecated, use node_pool.initial_node_count instead.", "format": "int32", "type": "integer" }, @@ -3478,12 +3521,12 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, "locations": { -"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -3527,7 +3570,7 @@ "type": "string" }, "network": { -"description": "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.", +"description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.", "type": "string" }, "networkConfig": { @@ -3661,7 +3704,7 @@ "type": "string" }, "subnetwork": { -"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.", +"description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.", "type": "string" }, "tpuIpv4CidrBlock": { @@ -3684,7 +3727,7 @@ }, "zone": { "deprecated": true, -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -3696,7 +3739,7 @@ "id": "ClusterAutoscaling", "properties": { "autoprovisioningLocations": { -"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", "items": { "type": "string" }, @@ -3761,6 +3804,10 @@ "$ref": "AdditionalPodRangesConfig", "description": "The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs." }, +"desiredAdditionalIpRangesConfig": { +"$ref": "DesiredAdditionalIPRangesConfig", +"description": "The desired config for additional subnetworks attached to the cluster." +}, "desiredAddonsConfig": { "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." @@ -3773,6 +3820,10 @@ "$ref": "AuthenticatorGroupsConfig", "description": "The desired authenticator groups config for the cluster." }, +"desiredAutoIpamConfig": { +"$ref": "AutoIpamConfig", +"description": "AutoIpamConfig contains all information related to Auto IPAM" +}, "desiredAutopilotWorkloadPolicyConfig": { "$ref": "WorkloadPolicyConfig", "description": "WorkloadPolicyConfig is the configuration related to GCW workload policy" @@ -3815,7 +3866,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", -"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." +"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -3903,7 +3954,7 @@ "description": "The desired L4 Internal Load Balancer Subsetting configuration." }, "desiredLocations": { -"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", +"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -4053,6 +4104,10 @@ ], "type": "string" }, +"desiredUserManagedKeysConfig": { +"$ref": "UserManagedKeysConfig", +"description": "The desired user managed keys config for the cluster." +}, "desiredVerticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." @@ -4069,13 +4124,18 @@ "description": "The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.", "type": "string" }, +"gkeAutoUpgradeConfig": { +"$ref": "GkeAutoUpgradeConfig", +"description": "Configuration for GKE auto upgrade." +}, "removedAdditionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", "description": "The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument." }, "userManagedKeysConfig": { "$ref": "UserManagedKeysConfig", -"description": "The Custom keys configuration for the cluster." +"deprecated": true, +"description": "The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead." } }, "type": "object" @@ -4169,12 +4229,12 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -4317,7 +4377,7 @@ "properties": { "cluster": { "$ref": "Cluster", -"description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)" +"description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters)" }, "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", @@ -4325,12 +4385,12 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4355,12 +4415,12 @@ }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4518,6 +4578,20 @@ }, "type": "object" }, +"DesiredAdditionalIPRangesConfig": { +"description": "DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs.", +"id": "DesiredAdditionalIPRangesConfig", +"properties": { +"additionalIpRangesConfigs": { +"description": "List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges", +"items": { +"$ref": "AdditionalIPRangesConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "DesiredEnterpriseConfig": { "description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.", "id": "DesiredEnterpriseConfig", @@ -4602,7 +4676,7 @@ "type": "integer" }, "localSsdCount": { -"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", +"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4670,7 +4744,7 @@ "type": "object" }, "GCPSecretManagerCertificateConfig": { -"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager).", +"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).", "id": "GCPSecretManagerCertificateConfig", "properties": { "secretUri": { @@ -4874,6 +4948,25 @@ false }, "type": "object" }, +"GkeAutoUpgradeConfig": { +"description": "GkeAutoUpgradeConfig is the configuration for GKE auto upgrades.", +"id": "GkeAutoUpgradeConfig", +"properties": { +"patchMode": { +"description": "PatchMode specifies how auto upgrade patch builds should be selected.", +"enum": [ +"PATCH_MODE_UNSPECIFIED", +"ACCELERATED" +], +"enumDescriptions": [ +"PATCH_MODE_UNSPECIFIED defaults to using the upgrade target from the channel's patch upgrade targets as the upgrade target for the version.", +"ACCELERATED denotes that the latest patch build in the channel should be used as the upgrade target for the version." +], +"type": "string" +} +}, +"type": "object" +}, "GkeBackupAgentConfig": { "description": "Configuration for the Backup for GKE Agent.", "id": "GkeBackupAgentConfig", @@ -4970,11 +5063,23 @@ false "description": "Configuration for controlling how IPs are allocated in the cluster.", "id": "IPAllocationPolicy", "properties": { +"additionalIpRangesConfigs": { +"description": "Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy.", +"items": { +"$ref": "AdditionalIPRangesConfig" +}, +"readOnly": true, +"type": "array" +}, "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", "description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, +"autoIpamConfig": { +"$ref": "AutoIpamConfig", +"description": "Optional. AutoIpamConfig contains all information related to Auto IPAM" +}, "clusterIpv4Cidr": { "deprecated": true, "description": "This field is deprecated, use cluster_ipv4_cidr_block.", @@ -5331,7 +5436,7 @@ false "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { -"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", +"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5504,12 +5609,12 @@ false }, "password": { "deprecated": true, -"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", +"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" }, "username": { "deprecated": true, -"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", +"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" } }, @@ -5681,7 +5786,7 @@ false "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", -"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." +"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -5740,7 +5845,7 @@ false "type": "string" }, "network": { -"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -5769,7 +5874,7 @@ false "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not." }, "subnetwork": { -"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "readOnly": true, "type": "string" } @@ -5844,7 +5949,7 @@ false "type": "object" }, "NodeAffinity": { -"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", +"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", "id": "NodeAffinity", "properties": { "key": { @@ -5880,7 +5985,7 @@ false "id": "NodeConfig", "properties": { "accelerators": { -"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", +"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -5891,7 +5996,7 @@ false "description": "Advanced features for the Compute Engine VM." }, "bootDiskKmsKey": { -"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", +"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", "type": "string" }, "confidentialNodes": { @@ -5951,7 +6056,7 @@ false "description": "Enable or disable gvnic in the node pool." }, "imageType": { -"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", +"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -5974,7 +6079,7 @@ false "description": "Parameters for using raw-block Local NVMe SSDs." }, "localSsdCount": { -"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", +"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.", "format": "int32", "type": "integer" }, @@ -5997,7 +6102,7 @@ false "description": "Logging configuration." }, "machineType": { -"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.", +"description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.", "type": "string" }, "maxRunDuration": { @@ -6013,27 +6118,27 @@ false "type": "object" }, "minCpuPlatform": { -"description": "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)", +"description": "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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)", "type": "string" }, "nodeGroup": { -"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).", +"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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", +"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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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": { "type": "string" }, "type": "array" }, "preemptible": { -"description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", +"description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "reservationAffinity": { "$ref": "ReservationAffinity", -"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool." +"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool." }, "resourceLabels": { "additionalProperties": { @@ -6318,12 +6423,12 @@ false "type": "string" }, "initialNodeCount": { -"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", +"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { -"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, @@ -6331,7 +6436,7 @@ false "type": "array" }, "locations": { -"description": "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.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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.", "items": { "type": "string" }, @@ -6411,7 +6516,7 @@ false "description": "Upgrade settings control disruption and speed of the upgrade." }, "version": { -"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).", +"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).", "type": "string" } }, @@ -6665,7 +6770,7 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, @@ -6730,21 +6835,21 @@ false "Not set.", "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.", "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.", -"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", -"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", -"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", -"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", -"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", +"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", +"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", +"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", +"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", +"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.", "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.", -"A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", +"A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", "Unused. Automatic node upgrade uses UPGRADE_NODES.", "Unused. Updating labels uses UPDATE_CLUSTER.", "Unused. Updating master auth uses UPDATE_CLUSTER.", "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.", "Unused. Updating network policy uses UPDATE_CLUSTER.", "Unused. Updating maintenance policy uses UPDATE_CLUSTER.", -"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", +"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], "readOnly": true, @@ -6797,7 +6902,7 @@ false }, "zone": { "deprecated": true, -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -6905,7 +7010,7 @@ false "type": "string" }, "tpuTopology": { -"description": "Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", +"description": "Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies", "type": "string" }, "type": { @@ -7217,7 +7322,7 @@ false "type": "object" }, "ReservationAffinity": { -"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", +"description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", "id": "ReservationAffinity", "properties": { "consumeReservationType": { @@ -7251,7 +7356,7 @@ false "type": "object" }, "ResourceLabels": { -"description": "Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", +"description": "Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -7286,7 +7391,7 @@ false "type": "object" }, "ResourceManagerTags": { -"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", +"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", "id": "ResourceManagerTags", "properties": { "tags": { @@ -7338,7 +7443,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "respectPdb": { @@ -7347,7 +7452,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7587,12 +7692,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7617,7 +7722,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "resourceLabels": { @@ -7629,7 +7734,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7654,12 +7759,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7675,7 +7780,7 @@ false "type": "string" }, "locations": { -"description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", +"description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", "items": { "type": "string" }, @@ -7687,12 +7792,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7717,12 +7822,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7745,11 +7850,11 @@ false "type": "string" }, "projectId": { -"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", +"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", "type": "string" }, "zone": { -"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", +"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", "type": "string" } }, @@ -7786,7 +7891,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -7795,7 +7900,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7820,12 +7925,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7850,12 +7955,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7885,12 +7990,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7920,12 +8025,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -7956,12 +8061,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8044,7 +8149,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "rotateCredentials": { @@ -8053,7 +8158,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8226,7 +8331,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8235,7 +8340,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8271,12 +8376,12 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8287,7 +8392,7 @@ false "id": "UpdateNodePoolRequest", "properties": { "accelerators": { -"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", +"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -8336,7 +8441,7 @@ false "description": "Enable or disable gvnic on the node pool." }, "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.", +"description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -8352,7 +8457,7 @@ false "description": "Parameters that can be configured on Linux nodes." }, "locations": { -"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", +"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", "items": { "type": "string" }, @@ -8363,7 +8468,7 @@ false "description": "Logging configuration." }, "machineType": { -"description": "Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.", +"description": "Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.", "type": "string" }, "maxRunDuration": { @@ -8390,7 +8495,7 @@ false }, "projectId": { "deprecated": true, -"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "queuedProvisioning": { @@ -8434,7 +8539,7 @@ false }, "zone": { "deprecated": true, -"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 204314acc3..853d069727 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -176,13 +176,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -278,7 +278,7 @@ ] }, "create": { -"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", +"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "id": "container.projects.locations.clusters.create", @@ -316,7 +316,7 @@ "parameters": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, @@ -329,13 +329,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -389,7 +389,7 @@ "parameters": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, @@ -402,13 +402,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -461,13 +461,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -538,7 +538,7 @@ }, "setLocations": { "deprecated": true, -"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", +"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLocations", @@ -888,7 +888,7 @@ "parameters": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, @@ -901,19 +901,19 @@ }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -967,7 +967,7 @@ "parameters": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, @@ -980,19 +980,19 @@ }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1016,7 +1016,7 @@ "parameters": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, @@ -1029,13 +1029,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1266,19 +1266,19 @@ }, "operationId": { "deprecated": true, -"description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1309,13 +1309,13 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1350,13 +1350,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1386,19 +1386,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1427,19 +1427,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1457,7 +1457,7 @@ ] }, "create": { -"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", +"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "id": "container.projects.zones.clusters.create", @@ -1467,13 +1467,13 @@ ], "parameters": { "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1502,7 +1502,7 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1513,13 +1513,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1575,7 +1575,7 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1586,13 +1586,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1618,19 +1618,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1663,13 +1663,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1685,7 +1685,7 @@ }, "locations": { "deprecated": true, -"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", +"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "id": "container.projects.zones.clusters.locations", @@ -1696,19 +1696,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1737,19 +1737,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1778,19 +1778,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1819,19 +1819,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1860,19 +1860,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1907,13 +1907,13 @@ "type": "string" }, "projectId": { -"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", +"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", +"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", "location": "path", "required": true, "type": "string" @@ -1942,19 +1942,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1983,19 +1983,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2024,19 +2024,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2065,19 +2065,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2111,25 +2111,25 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2158,19 +2158,19 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2200,7 +2200,7 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2211,19 +2211,19 @@ "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2280,7 +2280,7 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2291,19 +2291,19 @@ "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2329,7 +2329,7 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2340,13 +2340,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2373,25 +2373,25 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2421,25 +2421,25 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2469,25 +2469,25 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2517,25 +2517,25 @@ ], "parameters": { "clusterId": { -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { -"description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2570,19 +2570,19 @@ ], "parameters": { "operationId": { -"description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2616,19 +2616,19 @@ "type": "string" }, "operationId": { -"description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2658,13 +2658,13 @@ "type": "string" }, "projectId": { -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250513", +"revision": "20250603", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2698,7 +2698,7 @@ "type": "string" }, "acceleratorType": { -"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", +"description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)", "type": "string" }, "gpuDriverInstallationConfig": { @@ -2722,6 +2722,24 @@ }, "type": "object" }, +"AdditionalIPRangesConfig": { +"description": "AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster", +"id": "AdditionalIPRangesConfig", +"properties": { +"podIpv4RangeNames": { +"description": "List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2", +"items": { +"type": "string" +}, +"type": "array" +}, +"subnetwork": { +"description": "Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet", +"type": "string" +} +}, +"type": "object" +}, "AdditionalNodeNetworkConfig": { "description": "AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message", "id": "AdditionalNodeNetworkConfig", @@ -2839,7 +2857,7 @@ "kubernetesDashboard": { "$ref": "KubernetesDashboard", "deprecated": true, -"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards" +"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards" }, "networkPolicyConfig": { "$ref": "NetworkPolicyConfig", @@ -2926,7 +2944,22 @@ "AnonymousAuthenticationConfig": { "description": "AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication.", "id": "AnonymousAuthenticationConfig", -"properties": {}, +"properties": { +"mode": { +"description": "Defines the mode of limiting anonymous access in the cluster.", +"enum": [ +"MODE_UNSPECIFIED", +"ENABLED", +"LIMITED" +], +"enumDescriptions": [ +"Default value not specified.", +"Anonymous authentication is allowed for all endpoints.", +"Anonymous authentication is allowed for only health check endpoints." +], +"type": "string" +} +}, "type": "object" }, "AuthenticatorGroupsConfig": { @@ -2944,6 +2977,12 @@ }, "type": "object" }, +"AutoIpamConfig": { +"description": "AutoIpamConfig contains all information related to Auto IPAM", +"id": "AutoIpamConfig", +"properties": {}, +"type": "object" +}, "AutoMonitoringConfig": { "description": "AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.", "id": "AutoMonitoringConfig", @@ -3085,7 +3124,7 @@ "id": "AutoprovisioningNodePoolDefaults", "properties": { "bootDiskKmsKey": { -"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", +"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", "type": "string" }, "diskSizeGb": { @@ -3098,7 +3137,7 @@ "type": "string" }, "imageType": { -"description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", +"description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "insecureKubeletReadonlyPortEnabled": { @@ -3111,11 +3150,11 @@ }, "minCpuPlatform": { "deprecated": true, -"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. 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). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", +"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", +"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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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": { "type": "string" }, @@ -3307,17 +3346,17 @@ }, "operationId": { "deprecated": true, -"description": "Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -3495,7 +3534,7 @@ }, "currentNodeVersion": { "deprecated": true, -"description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", "readOnly": true, "type": "string" }, @@ -3546,6 +3585,10 @@ "$ref": "Fleet", "description": "Fleet information for the cluster." }, +"gkeAutoUpgradeConfig": { +"$ref": "GkeAutoUpgradeConfig", +"description": "Configuration for GKE auto upgrades." +}, "id": { "description": "Output only. Unique id for the cluster.", "readOnly": true, @@ -3561,7 +3604,7 @@ }, "initialNodeCount": { "deprecated": true, -"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") 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. This field is deprecated, use node_pool.initial_node_count instead.", +"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") 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. This field is deprecated, use node_pool.initial_node_count instead.", "format": "int32", "type": "integer" }, @@ -3587,12 +3630,12 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, "locations": { -"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -3645,7 +3688,7 @@ "type": "string" }, "network": { -"description": "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.", +"description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/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.", "type": "string" }, "networkConfig": { @@ -3793,7 +3836,7 @@ "type": "string" }, "subnetwork": { -"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.", +"description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.", "type": "string" }, "tpuConfig": { @@ -3829,7 +3872,7 @@ }, "zone": { "deprecated": true, -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -3841,7 +3884,7 @@ "id": "ClusterAutoscaling", "properties": { "autoprovisioningLocations": { -"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", "items": { "type": "string" }, @@ -3929,6 +3972,10 @@ "$ref": "AdditionalPodRangesConfig", "description": "The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs." }, +"desiredAdditionalIpRangesConfig": { +"$ref": "DesiredAdditionalIPRangesConfig", +"description": "The desired config for additional subnetworks attached to the cluster." +}, "desiredAddonsConfig": { "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." @@ -3941,6 +3988,10 @@ "$ref": "AuthenticatorGroupsConfig", "description": "AuthenticatorGroupsConfig specifies the config for the cluster security groups settings." }, +"desiredAutoIpamConfig": { +"$ref": "AutoIpamConfig", +"description": "AutoIpamConfig contains all information related to Auto IPAM" +}, "desiredAutopilotWorkloadPolicyConfig": { "$ref": "WorkloadPolicyConfig", "description": "WorkloadPolicyConfig is the configuration related to GCW workload policy" @@ -3987,7 +4038,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", -"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." +"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -4079,7 +4130,7 @@ "description": "The desired L4 Internal Load Balancer Subsetting configuration." }, "desiredLocations": { -"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", +"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -4247,6 +4298,10 @@ "deprecated": true, "description": "The desired Cloud TPU configuration. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25." }, +"desiredUserManagedKeysConfig": { +"$ref": "UserManagedKeysConfig", +"description": "The desired user managed keys config for the cluster." +}, "desiredVerticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." @@ -4271,6 +4326,10 @@ "description": "The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.", "type": "string" }, +"gkeAutoUpgradeConfig": { +"$ref": "GkeAutoUpgradeConfig", +"description": "Configuration for GKE auto upgrade." +}, "privateClusterConfig": { "$ref": "PrivateClusterConfig", "deprecated": true, @@ -4282,7 +4341,8 @@ }, "userManagedKeysConfig": { "$ref": "UserManagedKeysConfig", -"description": "The Custom keys configuration for the cluster." +"deprecated": true, +"description": "The Custom keys configuration for the cluster. This field is deprecated. Use ClusterUpdate.desired_user_managed_keys_config instead." } }, "type": "object" @@ -4367,7 +4427,7 @@ "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -4376,12 +4436,12 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -4524,7 +4584,7 @@ "properties": { "cluster": { "$ref": "Cluster", -"description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)" +"description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/projects.locations.clusters)" }, "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", @@ -4532,12 +4592,12 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4549,7 +4609,7 @@ "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.", "type": "string" }, "nodePool": { @@ -4562,12 +4622,12 @@ }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4747,6 +4807,20 @@ }, "type": "object" }, +"DesiredAdditionalIPRangesConfig": { +"description": "DesiredAdditionalIPRangesConfig is a wrapper used for cluster update operation and contains multiple AdditionalIPRangesConfigs.", +"id": "DesiredAdditionalIPRangesConfig", +"properties": { +"additionalIpRangesConfigs": { +"description": "List of additional IP ranges configs where each AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges", +"items": { +"$ref": "AdditionalIPRangesConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "DesiredEnterpriseConfig": { "description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.", "id": "DesiredEnterpriseConfig", @@ -4826,7 +4900,7 @@ "id": "EphemeralStorageConfig", "properties": { "localSsdCount": { -"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", +"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4843,7 +4917,7 @@ "type": "integer" }, "localSsdCount": { -"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", +"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4911,7 +4985,7 @@ "type": "object" }, "GCPSecretManagerCertificateConfig": { -"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager).", +"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).", "id": "GCPSecretManagerCertificateConfig", "properties": { "secretUri": { @@ -5115,6 +5189,25 @@ false }, "type": "object" }, +"GkeAutoUpgradeConfig": { +"description": "GkeAutoUpgradeConfig is the configuration for GKE auto upgrades.", +"id": "GkeAutoUpgradeConfig", +"properties": { +"patchMode": { +"description": "PatchMode specifies how auto upgrade patch builds should be selected.", +"enum": [ +"PATCH_MODE_UNSPECIFIED", +"ACCELERATED" +], +"enumDescriptions": [ +"PATCH_MODE_UNSPECIFIED defaults to using the upgrade target from the channel's patch upgrade targets as the upgrade target for the version.", +"ACCELERATED denotes that the latest patch build in the channel should be used as the upgrade target for the version." +], +"type": "string" +} +}, +"type": "object" +}, "GkeBackupAgentConfig": { "description": "Configuration for the Backup for GKE Agent.", "id": "GkeBackupAgentConfig", @@ -5236,6 +5329,14 @@ false "description": "Configuration for controlling how IPs are allocated in the cluster.", "id": "IPAllocationPolicy", "properties": { +"additionalIpRangesConfigs": { +"description": "Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy.", +"items": { +"$ref": "AdditionalIPRangesConfig" +}, +"readOnly": true, +"type": "array" +}, "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", "description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", @@ -5245,6 +5346,10 @@ false "description": "If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.", "type": "boolean" }, +"autoIpamConfig": { +"$ref": "AutoIpamConfig", +"description": "Optional. AutoIpamConfig contains all information related to Auto IPAM" +}, "clusterIpv4Cidr": { "deprecated": true, "description": "This field is deprecated, use cluster_ipv4_cidr_block.", @@ -5656,7 +5761,7 @@ false "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { -"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", +"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5864,12 +5969,12 @@ false }, "password": { "deprecated": true, -"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", +"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" }, "username": { "deprecated": true, -"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", +"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" } }, @@ -6061,7 +6166,7 @@ false "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", -"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." +"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -6120,7 +6225,7 @@ false "type": "string" }, "network": { -"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -6149,7 +6254,7 @@ false "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not." }, "subnetwork": { -"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "readOnly": true, "type": "string" } @@ -6236,7 +6341,7 @@ false "type": "object" }, "NodeAffinity": { -"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", +"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", "id": "NodeAffinity", "properties": { "key": { @@ -6272,7 +6377,7 @@ false "id": "NodeConfig", "properties": { "accelerators": { -"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", +"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -6283,7 +6388,7 @@ false "description": "Advanced features for the Compute Engine VM." }, "bootDiskKmsKey": { -"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", +"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", "type": "string" }, "confidentialNodes": { @@ -6351,7 +6456,7 @@ false "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts." }, "imageType": { -"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", +"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -6374,7 +6479,7 @@ false "description": "Parameters for using raw-block Local NVMe SSDs." }, "localSsdCount": { -"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", +"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.", "format": "int32", "type": "integer" }, @@ -6397,7 +6502,7 @@ false "description": "Logging configuration." }, "machineType": { -"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", +"description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", "type": "string" }, "maxRunDuration": { @@ -6413,27 +6518,27 @@ false "type": "object" }, "minCpuPlatform": { -"description": "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).", +"description": "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://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).", "type": "string" }, "nodeGroup": { -"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).", +"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://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, "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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", +"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 [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-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": { "type": "string" }, "type": "array" }, "preemptible": { -"description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", +"description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "reservationAffinity": { "$ref": "ReservationAffinity", -"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool." +"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool." }, "resourceLabels": { "additionalProperties": { @@ -6722,12 +6827,12 @@ false "type": "string" }, "initialNodeCount": { -"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", +"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { -"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, @@ -6735,7 +6840,7 @@ false "type": "array" }, "locations": { -"description": "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.", +"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/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://{$universe.dns_names.final_documentation_domain}/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.", "items": { "type": "string" }, @@ -6815,7 +6920,7 @@ false "description": "Upgrade settings control disruption and speed of the upgrade." }, "version": { -"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).", +"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).", "type": "string" } }, @@ -7069,7 +7174,7 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, @@ -7134,21 +7239,21 @@ false "Not set.", "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.", "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.", -"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", -"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", -"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", -"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", -"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", +"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", +"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", +"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", +"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", +"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.", "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.", -"A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", +"A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", "Unused. Automatic node upgrade uses UPGRADE_NODES.", "Unused. Updating labels uses UPDATE_CLUSTER.", "Unused. Updating master auth uses UPDATE_CLUSTER.", "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.", "Unused. Updating network policy uses UPDATE_CLUSTER.", "Unused. Updating maintenance policy uses UPDATE_CLUSTER.", -"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", +"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], "readOnly": true, @@ -7201,7 +7306,7 @@ false }, "zone": { "deprecated": true, -"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -7331,7 +7436,7 @@ false "type": "string" }, "tpuTopology": { -"description": "TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", +"description": "TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies", "type": "string" }, "type": { @@ -7698,7 +7803,7 @@ false "type": "object" }, "ReservationAffinity": { -"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", +"description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", "id": "ReservationAffinity", "properties": { "consumeReservationType": { @@ -7732,7 +7837,7 @@ false "type": "object" }, "ResourceLabels": { -"description": "Collection of [GCP labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", +"description": "Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -7767,7 +7872,7 @@ false "type": "object" }, "ResourceManagerTags": { -"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", +"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", "id": "ResourceManagerTags", "properties": { "tags": { @@ -7805,7 +7910,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -7814,12 +7919,12 @@ false }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "respectPdb": { @@ -7828,7 +7933,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8091,7 +8196,7 @@ false }, "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8100,12 +8205,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8117,7 +8222,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "type": "string" }, "labelFingerprint": { @@ -8130,7 +8235,7 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "resourceLabels": { @@ -8142,7 +8247,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8154,7 +8259,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "type": "string" }, "enabled": { @@ -8167,12 +8272,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8184,11 +8289,11 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "locations": { -"description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", +"description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", "items": { "type": "string" }, @@ -8200,12 +8305,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8217,7 +8322,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "loggingService": { @@ -8230,12 +8335,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8258,11 +8363,11 @@ false "type": "string" }, "projectId": { -"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", +"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", "type": "string" }, "zone": { -"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", +"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", "type": "string" } }, @@ -8290,7 +8395,7 @@ false }, "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8299,7 +8404,7 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8308,7 +8413,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8320,7 +8425,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "monitoringService": { @@ -8333,12 +8438,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8350,7 +8455,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8363,12 +8468,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8384,7 +8489,7 @@ false }, "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8393,17 +8498,17 @@ false }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8415,7 +8520,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "type": "string" }, "management": { @@ -8428,17 +8533,17 @@ false }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8450,7 +8555,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8464,17 +8569,17 @@ false }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8548,7 +8653,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8557,7 +8662,7 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "rotateCredentials": { @@ -8566,7 +8671,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8750,7 +8855,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "name": { @@ -8759,7 +8864,7 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8768,7 +8873,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8791,7 +8896,7 @@ false "properties": { "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "masterVersion": { @@ -8804,12 +8909,12 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8820,7 +8925,7 @@ false "id": "UpdateNodePoolRequest", "properties": { "accelerators": { -"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", +"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -8828,7 +8933,7 @@ false }, "clusterId": { "deprecated": true, -"description": "Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "confidentialNodes": { @@ -8869,7 +8974,7 @@ false "description": "Enable or disable gvnic on the node pool." }, "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.", +"description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -8885,7 +8990,7 @@ false "description": "Parameters that can be configured on Linux nodes." }, "locations": { -"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", +"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", "items": { "type": "string" }, @@ -8914,7 +9019,7 @@ false }, "nodePoolId": { "deprecated": true, -"description": "Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.", "type": "string" }, "nodeVersion": { @@ -8923,7 +9028,7 @@ false }, "projectId": { "deprecated": true, -"description": "Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "queuedProvisioning": { @@ -8967,7 +9072,7 @@ false }, "zone": { "deprecated": true, -"description": "Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", +"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json index a43ab5418c..54402c4bb0 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json @@ -183,7 +183,7 @@ "methods": { "retrieveConfig": { "deprecated": true, -"description": "Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set.", +"description": "Retrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects under it which have a separate configuration set.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig", "httpMethod": "GET", "id": "datacatalog.organizations.locations.retrieveConfig", @@ -209,7 +209,7 @@ }, "retrieveEffectiveConfig": { "deprecated": true, -"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", +"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig", "httpMethod": "GET", "id": "datacatalog.organizations.locations.retrieveEffectiveConfig", @@ -235,7 +235,7 @@ }, "setConfig": { "deprecated": true, -"description": "Sets the configuration related to the migration to Dataplex for an organization or project.", +"description": "Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:setConfig", "httpMethod": "POST", "id": "datacatalog.organizations.locations.setConfig", @@ -272,7 +272,7 @@ "methods": { "retrieveEffectiveConfig": { "deprecated": true, -"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", +"description": "Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveEffectiveConfig", "httpMethod": "GET", "id": "datacatalog.projects.locations.retrieveEffectiveConfig", @@ -298,7 +298,7 @@ }, "setConfig": { "deprecated": true, -"description": "Sets the configuration related to the migration to Dataplex for an organization or project.", +"description": "Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setConfig", "httpMethod": "POST", "id": "datacatalog.projects.locations.setConfig", @@ -2339,7 +2339,7 @@ } } }, -"revision": "20250520", +"revision": "20250609", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2823,7 +2823,7 @@ }, "dataplexTable": { "$ref": "GoogleCloudDatacatalogV1DataplexTableSpec", -"description": "Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries.", +"description": "Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries.", "readOnly": true }, "type": { @@ -2873,7 +2873,7 @@ "type": "object" }, "GoogleCloudDatacatalogV1DataplexExternalTable": { -"description": "External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them \"external tables\". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.", +"description": "External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them \"external tables\". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.", "id": "GoogleCloudDatacatalogV1DataplexExternalTable", "properties": { "dataCatalogEntry": { @@ -2907,7 +2907,7 @@ "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", -"Dataplex.", +"Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", @@ -2920,22 +2920,22 @@ "type": "object" }, "GoogleCloudDatacatalogV1DataplexFilesetSpec": { -"description": "Entry specyfication for a Dataplex fileset.", +"description": "Entry specification for a Dataplex Universal Catalog fileset.", "id": "GoogleCloudDatacatalogV1DataplexFilesetSpec", "properties": { "dataplexSpec": { "$ref": "GoogleCloudDatacatalogV1DataplexSpec", -"description": "Common Dataplex fields." +"description": "Common Dataplex Universal Catalog fields." } }, "type": "object" }, "GoogleCloudDatacatalogV1DataplexSpec": { -"description": "Common Dataplex fields.", +"description": "Common Dataplex Universal Catalog fields.", "id": "GoogleCloudDatacatalogV1DataplexSpec", "properties": { "asset": { -"description": "Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.", +"description": "Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.", "type": "string" }, "compressionFormat": { @@ -2947,22 +2947,22 @@ "description": "Format of the data." }, "projectId": { -"description": "Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset.", +"description": "Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset.", "type": "string" } }, "type": "object" }, "GoogleCloudDatacatalogV1DataplexTableSpec": { -"description": "Entry specification for a Dataplex table.", +"description": "Entry specification for a Dataplex Universal Catalog table.", "id": "GoogleCloudDatacatalogV1DataplexTableSpec", "properties": { "dataplexSpec": { "$ref": "GoogleCloudDatacatalogV1DataplexSpec", -"description": "Common Dataplex fields." +"description": "Common Dataplex Universal Catalog fields." }, "externalTables": { -"description": "List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems.", +"description": "List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems.", "items": { "$ref": "GoogleCloudDatacatalogV1DataplexExternalTable" }, @@ -3079,7 +3079,7 @@ "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", -"Dataplex.", +"Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", @@ -3171,8 +3171,8 @@ "A database.", "Connection to a data source. For example, a BigQuery connection.", "Routine, for example, a BigQuery routine.", -"A Dataplex lake.", -"A Dataplex zone.", +"A Dataplex Universal Catalog lake.", +"A Dataplex Universal Catalog zone.", "A service, for example, a Dataproc Metastore service.", "Schema within a relational database.", "A Dashboard, for example from Looker.", @@ -3221,7 +3221,7 @@ "type": "string" }, "transferredToDataplex": { -"description": "Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Catalog Service. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.", +"description": "Optional. When set to [true], it means DataCatalog EntryGroup was transferred to Dataplex Universal Catalog. It makes EntryGroup and its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset.", "type": "boolean" } }, @@ -3333,7 +3333,7 @@ "properties": { "dataplexFileset": { "$ref": "GoogleCloudDatacatalogV1DataplexFilesetSpec", -"description": "Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries." +"description": "Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries." } }, "type": "object" @@ -3423,7 +3423,7 @@ "type": "string" }, "jobId": { -"description": "Optional. (Optional) Dataplex task job id, if specified will be used as part of ImportEntries LRO ID", +"description": "Optional. (Optional) Dataplex Universal Catalog task job id, if specified will be used as part of ImportEntries LRO ID", "type": "string" } }, @@ -3611,34 +3611,34 @@ "type": "object" }, "GoogleCloudDatacatalogV1MigrationConfig": { -"description": "The configuration related to the migration to Dataplex applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.", +"description": "The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.", "id": "GoogleCloudDatacatalogV1MigrationConfig", "properties": { "catalogUiExperience": { -"description": "Opt-in status for the UI switch to Dataplex.", +"description": "Opt-in status for the UI switch to Dataplex Universal Catalog.", "enum": [ "CATALOG_UI_EXPERIENCE_UNSPECIFIED", "CATALOG_UI_EXPERIENCE_ENABLED", "CATALOG_UI_EXPERIENCE_DISABLED" ], "enumDescriptions": [ -"Default value. The default UI is Dataplex.", -"The UI is Dataplex.", +"Default value. The default UI is Dataplex Universal Catalog.", +"The UI is Dataplex Universal Catalog.", "The UI is Data Catalog." ], "type": "string" }, "tagTemplateMigration": { -"description": "Opt-in status for the migration of Tag Templates to Dataplex.", +"description": "Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.", "enum": [ "TAG_TEMPLATE_MIGRATION_UNSPECIFIED", "TAG_TEMPLATE_MIGRATION_ENABLED", "TAG_TEMPLATE_MIGRATION_DISABLED" ], "enumDescriptions": [ -"Default value. Migration of Tag Templates from Data Catalog to Dataplex is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", -"Migration of Tag Templates from Data Catalog to Dataplex is enabled.", -"Migration of Tag Templates from Data Catalog to Dataplex is disabled." +"Default value. Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", +"Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is enabled.", +"Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is disabled." ], "type": "string" }, @@ -3684,7 +3684,7 @@ "type": "object" }, "GoogleCloudDatacatalogV1OrganizationConfig": { -"description": "The configuration related to the migration from Data Catalog to Dataplex that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.", +"description": "The configuration related to the migration from Data Catalog to Dataplex Universal Catalog that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.", "id": "GoogleCloudDatacatalogV1OrganizationConfig", "properties": { "config": { @@ -4160,7 +4160,7 @@ "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", -"Dataplex.", +"Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", @@ -4289,30 +4289,30 @@ "id": "GoogleCloudDatacatalogV1SetConfigRequest", "properties": { "catalogUiExperience": { -"description": "Opt-in status for the UI switch to Dataplex.", +"description": "Opt-in status for the UI switch to Dataplex Universal Catalog.", "enum": [ "CATALOG_UI_EXPERIENCE_UNSPECIFIED", "CATALOG_UI_EXPERIENCE_ENABLED", "CATALOG_UI_EXPERIENCE_DISABLED" ], "enumDescriptions": [ -"Default value. The default UI is Dataplex.", -"The UI is Dataplex.", +"Default value. The default UI is Dataplex Universal Catalog.", +"The UI is Dataplex Universal Catalog.", "The UI is Data Catalog." ], "type": "string" }, "tagTemplateMigration": { -"description": "Opt-in status for the migration of Tag Templates to Dataplex.", +"description": "Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.", "enum": [ "TAG_TEMPLATE_MIGRATION_UNSPECIFIED", "TAG_TEMPLATE_MIGRATION_ENABLED", "TAG_TEMPLATE_MIGRATION_DISABLED" ], "enumDescriptions": [ -"Default value. Migration of Tag Templates from Data Catalog to Dataplex is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", -"Migration of Tag Templates from Data Catalog to Dataplex is enabled.", -"Migration of Tag Templates from Data Catalog to Dataplex is disabled." +"Default value. Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is not performed. For projects that are under an organization, the project inherits the organization's configuration when you set the project-level configuration to unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means that when migration is enabled at the organization level, and the project-level configuration is unspecified, the project is migrated. To explicitly opt-in or opt-out individual projects, set the project-level configuration to enabled (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled (`TAG_TEMPLATE_MIGRATION_DISABLED`).", +"Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is enabled.", +"Migration of Tag Templates from Data Catalog to Dataplex Universal Catalog is disabled." ], "type": "string" } @@ -4424,9 +4424,9 @@ true, false ], "enumDescriptions": [ -"Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." +"Default value. TagTemplate and its tags are only visible and editable in Data Catalog.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Dataplex Universal Catalog, read-only in Data Catalog." ], "readOnly": true, "type": "string" @@ -4526,9 +4526,9 @@ true, false ], "enumDescriptions": [ -"Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." +"Default value. TagTemplate and its tags are only visible and editable in Data Catalog.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Dataplex Universal Catalog, read-only in Data Catalog." ], "type": "string" }, @@ -4678,7 +4678,7 @@ false ], "enumDescriptions": [ "Default value", -"Dataplex.", +"Dataplex Universal Catalog.", "Other" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 77b6e5d6d5..981538b154 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -1855,7 +1855,7 @@ } } }, -"revision": "20250502", +"revision": "20250609", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2328,7 +2328,7 @@ }, "dataplexTable": { "$ref": "GoogleCloudDatacatalogV1DataplexTableSpec", -"description": "Output only. Fields specific to a Dataplex table and present only in the Dataplex table entries.", +"description": "Output only. Fields specific to a Dataplex Universal Catalog table and present only in the Dataplex Universal Catalog table entries.", "readOnly": true }, "type": { @@ -2378,7 +2378,7 @@ "type": "object" }, "GoogleCloudDatacatalogV1DataplexExternalTable": { -"description": "External table registered by Dataplex. Dataplex publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them \"external tables\". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.", +"description": "External table registered by Dataplex Universal Catalog. Dataplex Universal Catalog publishes data discovered from an asset into multiple other systems (BigQuery, DPMS) in form of tables. We call them \"external tables\". External tables are also synced into the Data Catalog. This message contains pointers to those external tables (fully qualified name, resource name et cetera) within the Data Catalog.", "id": "GoogleCloudDatacatalogV1DataplexExternalTable", "properties": { "dataCatalogEntry": { @@ -2412,7 +2412,7 @@ "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", -"Dataplex.", +"Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", @@ -2425,22 +2425,22 @@ "type": "object" }, "GoogleCloudDatacatalogV1DataplexFilesetSpec": { -"description": "Entry specyfication for a Dataplex fileset.", +"description": "Entry specification for a Dataplex Universal Catalog fileset.", "id": "GoogleCloudDatacatalogV1DataplexFilesetSpec", "properties": { "dataplexSpec": { "$ref": "GoogleCloudDatacatalogV1DataplexSpec", -"description": "Common Dataplex fields." +"description": "Common Dataplex Universal Catalog fields." } }, "type": "object" }, "GoogleCloudDatacatalogV1DataplexSpec": { -"description": "Common Dataplex fields.", +"description": "Common Dataplex Universal Catalog fields.", "id": "GoogleCloudDatacatalogV1DataplexSpec", "properties": { "asset": { -"description": "Fully qualified resource name of an asset in Dataplex, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.", +"description": "Fully qualified resource name of an asset in Dataplex Universal Catalog, to which the underlying data source (Cloud Storage bucket or BigQuery dataset) of the entity is attached.", "type": "string" }, "compressionFormat": { @@ -2452,22 +2452,22 @@ "description": "Format of the data." }, "projectId": { -"description": "Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the correspondingly Dataplex lake / zone / asset.", +"description": "Project ID of the underlying Cloud Storage or BigQuery data. Note that this may not be the same project as the corresponding Dataplex Universal Catalog lake / zone / asset.", "type": "string" } }, "type": "object" }, "GoogleCloudDatacatalogV1DataplexTableSpec": { -"description": "Entry specification for a Dataplex table.", +"description": "Entry specification for a Dataplex Universal Catalog table.", "id": "GoogleCloudDatacatalogV1DataplexTableSpec", "properties": { "dataplexSpec": { "$ref": "GoogleCloudDatacatalogV1DataplexSpec", -"description": "Common Dataplex fields." +"description": "Common Dataplex Universal Catalog fields." }, "externalTables": { -"description": "List of external tables registered by Dataplex in other systems based on the same underlying data. External tables allow to query this data in those systems.", +"description": "List of external tables registered by Dataplex Universal Catalog in other systems based on the same underlying data. External tables allow to query this data in those systems.", "items": { "$ref": "GoogleCloudDatacatalogV1DataplexExternalTable" }, @@ -2584,7 +2584,7 @@ "BigQuery.", "Cloud Pub/Sub.", "Dataproc Metastore.", -"Dataplex.", +"Dataplex Universal Catalog.", "Cloud Spanner", "Cloud Bigtable", "Cloud Sql", @@ -2676,8 +2676,8 @@ "A database.", "Connection to a data source. For example, a BigQuery connection.", "Routine, for example, a BigQuery routine.", -"A Dataplex lake.", -"A Dataplex zone.", +"A Dataplex Universal Catalog lake.", +"A Dataplex Universal Catalog zone.", "A service, for example, a Dataproc Metastore service.", "Schema within a relational database.", "A Dashboard, for example from Looker.", @@ -2743,7 +2743,7 @@ "properties": { "dataplexFileset": { "$ref": "GoogleCloudDatacatalogV1DataplexFilesetSpec", -"description": "Fields specific to a Dataplex fileset and present only in the Dataplex fileset entries." +"description": "Fields specific to a Dataplex Universal Catalog fileset and present only in the Dataplex Universal Catalog fileset entries." } }, "type": "object" @@ -3226,9 +3226,9 @@ true, false ], "enumDescriptions": [ -"Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in Dataplex, read-only in DataCatalog." +"Default value. TagTemplate and its tags are only visible and editable in Data Catalog.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.", +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Dataplex Universal Catalog, read-only in Data Catalog." ], "readOnly": true, "type": "string" @@ -4348,7 +4348,7 @@ true ], "enumDescriptions": [ "Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", -"TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in." +"TagTemplate and its tags are auto-copied to Dataplex Universal Catalog service. Visible in both services. Editable in Data Catalog, read-only in Dataplex Universal Catalog. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in." ], "readOnly": true, "type": "string" @@ -4471,7 +4471,7 @@ true ], "enumDescriptions": [ "Default value", -"Dataplex.", +"Dataplex Universal Catalog.", "Other" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index b4ea2a47ce..0f01e8f43e 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -349,7 +349,7 @@ ], "parameters": { "force": { -"description": "Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)", +"description": "Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.", "location": "query", "type": "boolean" }, @@ -2147,7 +2147,7 @@ } } }, -"revision": "20250518", +"revision": "20250608", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { diff --git a/googleapiclient/discovery_cache/documents/datafusion.v1.json b/googleapiclient/discovery_cache/documents/datafusion.v1.json index ad9180945b..2d877d8fd3 100644 --- a/googleapiclient/discovery_cache/documents/datafusion.v1.json +++ b/googleapiclient/discovery_cache/documents/datafusion.v1.json @@ -227,6 +227,11 @@ "name" ], "parameters": { +"force": { +"description": "Optional. If set to true, any nested resources from this instance will also be deleted.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}", "location": "path", @@ -738,7 +743,7 @@ } } }, -"revision": "20250414", +"revision": "20250610", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json b/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json index 0c38cc9c52..85de3e79aa 100644 --- a/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datafusion.v1beta1.json @@ -255,6 +255,11 @@ "name" ], "parameters": { +"force": { +"description": "Optional. If set to true, any nested resources from this instance will also be deleted.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}", "location": "path", @@ -936,7 +941,7 @@ } } }, -"revision": "20250414", +"revision": "20250610", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1062,7 +1067,7 @@ "id": "CryptoKeyConfig", "properties": { "keyReference": { -"description": "The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", +"description": "Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", "type": "string" } }, @@ -1081,7 +1086,7 @@ "type": "string" }, "name": { -"description": "Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering}", +"description": "Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering}", "type": "string" }, "targetNetwork": { @@ -1187,18 +1192,18 @@ }, "cryptoKeyConfig": { "$ref": "CryptoKeyConfig", -"description": "The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature." +"description": "Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature." }, "dataplexDataLineageIntegrationEnabled": { "description": "Optional. Option to enable the Dataplex Lineage Integration feature.", "type": "boolean" }, "dataprocServiceAccount": { -"description": "User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.", +"description": "Optional. User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.", "type": "string" }, "description": { -"description": "A description of this instance.", +"description": "Optional. A description of this instance.", "type": "string" }, "disabledReason": { @@ -1218,28 +1223,29 @@ "type": "array" }, "displayName": { -"description": "Display name for an instance.", +"description": "Optional. Display name for an instance.", "type": "string" }, "enableRbac": { -"description": "Option to enable granular role-based access control.", +"description": "Optional. Option to enable granular role-based access control.", "type": "boolean" }, "enableStackdriverLogging": { -"description": "Option to enable Dataproc Stackdriver Logging.", +"description": "Optional. Option to enable Dataproc Stackdriver Logging.", "type": "boolean" }, "enableStackdriverMonitoring": { -"description": "Option to enable Stackdriver Monitoring.", +"description": "Optional. Option to enable Stackdriver Monitoring.", "type": "boolean" }, "enableZoneSeparation": { -"description": "Option to enable zone separation.", +"description": "Output only. Option to enable zone separation.", +"readOnly": true, "type": "boolean" }, "eventPublishConfig": { "$ref": "EventPublishConfig", -"description": "Option to enable and pass metadata for event publishing." +"description": "Optional. Option to enable and pass metadata for event publishing." }, "gcsBucket": { "description": "Output only. Cloud Storage bucket generated by Data Fusion in the customer project.", @@ -1276,13 +1282,13 @@ }, "networkConfig": { "$ref": "NetworkConfig", -"description": "Network configuration options. These are required when a private Data Fusion instance is to be created." +"description": "Optional. Network configuration options. These are required when a private Data Fusion instance is to be created." }, "options": { "additionalProperties": { "type": "string" }, -"description": "Map of additional options used to configure the behavior of Data Fusion instance.", +"description": "Optional. Map of additional options used to configure the behavior of Data Fusion instance.", "type": "object" }, "p4ServiceAccount": { @@ -1295,7 +1301,7 @@ "type": "string" }, "privateInstance": { -"description": "Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.", +"description": "Optional. Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.", "type": "boolean" }, "satisfiesPzi": { @@ -1390,7 +1396,7 @@ "type": "string" }, "version": { -"description": "Current version of Data Fusion.", +"description": "Optional. Current version of Data Fusion.", "type": "string" }, "workforceIdentityServiceEndpoint": { @@ -1399,7 +1405,7 @@ "type": "string" }, "zone": { -"description": "Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.", +"description": "Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 52160d1686..bcce734a60 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -4998,7 +4998,7 @@ } } }, -"revision": "20250521", +"revision": "20250604", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5472,8 +5472,8 @@ ], "enumDescriptions": [ "Not set.", -"Standard dataproc cluster with minimum 2 primary workers.", -"Clusters that can be scaled down to zero worker nodes." +"Standard dataproc cluster with a minimum of two primary workers.", +"Clusters that can use only secondary workers and be scaled down to zero secondary worker nodes." ], "type": "string" }, @@ -5893,6 +5893,20 @@ }, "type": "array" }, +"clusterTier": { +"description": "Optional. The tier of the cluster.", +"enum": [ +"CLUSTER_TIER_UNSPECIFIED", +"CLUSTER_TIER_STANDARD", +"CLUSTER_TIER_PREMIUM" +], +"enumDescriptions": [ +"Not set. Works the same as CLUSTER_TIER_STANDARD.", +"Standard dataproc cluster.", +"Premium dataproc cluster." +], +"type": "string" +}, "clusterType": { "description": "Optional. The type of the cluster.", "enum": [ @@ -5905,7 +5919,7 @@ "Not set.", "Standard dataproc cluster with a minimum of two primary workers.", "https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/single-node-clusters", -"Clusters that can be scaled down to zero worker nodes." +"Clusters that can use only secondary workers and be scaled down to zero secondary worker nodes." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 7c8244ff3e..24686fb61d 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8805,7 +8805,7 @@ } } }, -"revision": "20250602", +"revision": "20250612", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -20063,7 +20063,7 @@ true "id": "GoogleCloudDialogflowV2ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -20081,7 +20081,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -20092,7 +20092,7 @@ true "id": "GoogleCloudDialogflowV2ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -20115,7 +20115,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -23110,7 +23110,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -23128,7 +23128,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -23139,7 +23139,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -23162,7 +23162,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index e2eeb8abd9..8fb854ac7e 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8602,7 +8602,7 @@ } } }, -"revision": "20250602", +"revision": "20250612", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15863,7 +15863,7 @@ true "id": "GoogleCloudDialogflowV2ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -15881,7 +15881,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -15892,7 +15892,7 @@ true "id": "GoogleCloudDialogflowV2ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -15915,7 +15915,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -22982,7 +22982,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -23000,7 +23000,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -23011,7 +23011,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -23034,7 +23034,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index dbff43daee..75d97d4fae 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -5309,7 +5309,7 @@ } } }, -"revision": "20250602", +"revision": "20250612", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -9840,6 +9840,10 @@ false "$ref": "GoogleCloudDialogflowCxV3LlmModelSettings", "description": "Optional. Use the specified LLM model settings for processing the request." }, +"parameterScope": { +"description": "Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id.", +"type": "string" +}, "parameters": { "additionalProperties": { "description": "Properties of the object.", @@ -17140,7 +17144,7 @@ true "id": "GoogleCloudDialogflowV2ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -17158,7 +17162,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -17169,7 +17173,7 @@ true "id": "GoogleCloudDialogflowV2ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -17192,7 +17196,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -20053,7 +20057,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -20071,7 +20075,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -20082,7 +20086,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -20105,7 +20109,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 0088e38eda..4e5a6662cc 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5436,7 +5436,7 @@ } } }, -"revision": "20250602", +"revision": "20250612", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -13321,6 +13321,10 @@ false "$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings", "description": "Optional. Use the specified LLM model settings for processing the request." }, +"parameterScope": { +"description": "Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id.", +"type": "string" +}, "parameters": { "additionalProperties": { "description": "Properties of the object.", @@ -18510,7 +18514,7 @@ true "id": "GoogleCloudDialogflowV2ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -18528,7 +18532,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -18539,7 +18543,7 @@ true "id": "GoogleCloudDialogflowV2ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -18562,7 +18566,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -21423,7 +21427,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCall", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "createTime": { @@ -21441,7 +21445,7 @@ true "type": "object" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, @@ -21452,7 +21456,7 @@ true "id": "GoogleCloudDialogflowV2beta1ToolCallResult", "properties": { "action": { -"description": "Required. The name of the tool's action associated with this call.", +"description": "Optional. The name of the tool's action associated with this call.", "type": "string" }, "content": { @@ -21475,7 +21479,7 @@ true "type": "string" }, "tool": { -"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.", +"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index a39cede70b..aec3039316 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -7052,7 +7052,7 @@ } } }, -"revision": "20250604", +"revision": "20250609", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -12238,6 +12238,10 @@ "description": "Principal identifier of a user or a group.", "id": "GoogleCloudDiscoveryengineV1Principal", "properties": { +"externalEntityId": { +"description": "For 3P application identities which are not present in the customer identity provider.", +"type": "string" +}, "groupId": { "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", "type": "string" @@ -12582,7 +12586,8 @@ "id": "GoogleCloudDiscoveryengineV1Query", "properties": { "queryId": { -"description": "Unique Id for the query.", +"description": "Output only. Unique Id for the query.", +"readOnly": true, "type": "string" }, "text": { @@ -14168,7 +14173,7 @@ "id": "GoogleCloudDiscoveryengineV1SessionTurn", "properties": { "answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "detailedAnswer": { @@ -14178,14 +14183,7 @@ }, "query": { "$ref": "GoogleCloudDiscoveryengineV1Query", -"description": "The user query." -}, -"queryConfigs": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"", -"type": "object" +"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" } }, "type": "object" @@ -18863,7 +18861,8 @@ "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { "queryId": { -"description": "Unique Id for the query.", +"description": "Output only. Unique Id for the query.", +"readOnly": true, "type": "string" }, "text": { @@ -19303,7 +19302,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -19311,12 +19310,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, @@ -19370,6 +19380,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, +"useLatestData": { +"description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.", +"type": "boolean" +}, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." @@ -20052,7 +20066,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "detailedAnswer": { @@ -20062,14 +20076,7 @@ }, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -}, -"queryConfigs": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"", -"type": "object" +"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" } }, "type": "object" @@ -22882,7 +22889,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -22890,12 +22897,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 711c5c4af1..ed6c02c306 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -9173,7 +9173,7 @@ } } }, -"revision": "20250604", +"revision": "20250609", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -19873,6 +19873,10 @@ "description": "Principal identifier of a user or a group.", "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", "properties": { +"externalEntityId": { +"description": "For 3P application identities which are not present in the customer identity provider.", +"type": "string" +}, "groupId": { "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", "type": "string" @@ -20325,7 +20329,8 @@ "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { "queryId": { -"description": "Unique Id for the query.", +"description": "Output only. Unique Id for the query.", +"readOnly": true, "type": "string" }, "text": { @@ -21319,7 +21324,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -21327,12 +21332,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, @@ -21386,6 +21402,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, +"useLatestData": { +"description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.", +"type": "boolean" +}, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." @@ -22967,7 +22987,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "detailedAnswer": { @@ -22977,14 +22997,7 @@ }, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -}, -"queryConfigs": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"", -"type": "object" +"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" } }, "type": "object" @@ -26922,7 +26935,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -26930,12 +26943,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 21242a7532..e4a91f83f5 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -8004,7 +8004,7 @@ } } }, -"revision": "20250604", +"revision": "20250609", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -15049,7 +15049,8 @@ "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { "queryId": { -"description": "Unique Id for the query.", +"description": "Output only. Unique Id for the query.", +"readOnly": true, "type": "string" }, "text": { @@ -15489,7 +15490,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -15497,12 +15498,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, @@ -15556,6 +15568,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, +"useLatestData": { +"description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.", +"type": "boolean" +}, "userInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics." @@ -16238,7 +16254,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { "answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "detailedAnswer": { @@ -16248,14 +16264,7 @@ }, "query": { "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -}, -"queryConfigs": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"", -"type": "object" +"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" } }, "type": "object" @@ -22400,6 +22409,10 @@ "description": "Principal identifier of a user or a group.", "id": "GoogleCloudDiscoveryengineV1betaPrincipal", "properties": { +"externalEntityId": { +"description": "For 3P application identities which are not present in the customer identity provider.", +"type": "string" +}, "groupId": { "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", "type": "string" @@ -22763,7 +22776,8 @@ "id": "GoogleCloudDiscoveryengineV1betaQuery", "properties": { "queryId": { -"description": "Unique Id for the query.", +"description": "Output only. Unique Id for the query.", +"readOnly": true, "type": "string" }, "text": { @@ -23446,7 +23460,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "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 BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, 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. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * 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 * `base_rank`: the default rank of the result", "type": "string" }, "rankingExpressionBackend": { @@ -23454,12 +23468,23 @@ "enum": [ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED", "BYOE", -"CLEARBOX" +"CLEARBOX", +"RANK_BY_EMBEDDING", +"RANK_BY_FORMULA" +], +"enumDeprecated": [ +false, +true, +true, +false, +false ], "enumDescriptions": [ "Default option for unspecified/unknown values.", -"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.", -"The expression is compiled into a Clearbox formula." +"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.", +"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.", +"Ranking by custom embedding model, the default way to evaluate the ranking expression.", +"Ranking by custom formula." ], "type": "string" }, @@ -25086,7 +25111,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSessionTurn", "properties": { "answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, "detailedAnswer": { @@ -25096,14 +25121,7 @@ }, "query": { "$ref": "GoogleCloudDiscoveryengineV1betaQuery", -"description": "The user query." -}, -"queryConfigs": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"", -"type": "object" +"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index ea3865b611..f4438a2be2 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5118,7 +5118,7 @@ } } }, -"revision": "20250525", +"revision": "20250608", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -8585,7 +8585,7 @@ "type": "object" }, "GooglePrivacyDlpV2FileStoreCollection": { -"description": "Match file stores (e.g. buckets) using regex filters.", +"description": "Match file stores (e.g. buckets) using filters.", "id": "GooglePrivacyDlpV2FileStoreCollection", "properties": { "includeRegexes": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index dfb99e46b0..a7f2149901 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20250311", +"revision": "20250610", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { @@ -169,7 +169,7 @@ "type": "object" }, "directBootOk": { -"description": "If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot).", +"description": "Optional. If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode. See [Support Direct Boot mode](https://developer.android.com/training/articles/direct-boot).", "type": "boolean" }, "fcmOptions": { @@ -196,6 +196,10 @@ "description": "Package name of the application where the registration token must match in order to receive the message.", "type": "string" }, +"restrictedSatelliteOk": { +"description": "Optional. If set to true, messages will be allowed to be delivered to the app while the device is connected over a restricted satellite network. This should only be enabled for messages that can be handled over a restricted satellite network and only for apps that are allowed to work over a restricted satellite network. Note that the ability of the app to connect to a restricted satellite network is dependent on the carrier's settings and the device model.", +"type": "boolean" +}, "ttl": { "description": "How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix \"s\" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as \"3s\", while 3 seconds and 1 nanosecond should be expressed in JSON format as \"3.000000001s\". The ttl will be rounded down to the nearest second.", "format": "google-duration", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 1770008e08..066f84f07f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -807,7 +807,7 @@ } } }, -"revision": "20250416", +"revision": "20250612", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -825,6 +825,29 @@ }, "type": "object" }, +"AndroidxCrawlerOutputRectangle": { +"description": "Rectangle for describing bounding boxes", +"id": "AndroidxCrawlerOutputRectangle", +"properties": { +"bottom": { +"format": "int32", +"type": "integer" +}, +"left": { +"format": "int32", +"type": "integer" +}, +"right": { +"format": "int32", +"type": "integer" +}, +"top": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1Release": { "description": "A release of a Firebase app.", "id": "GoogleFirebaseAppdistroV1Release", @@ -1288,6 +1311,11 @@ "description": "An interaction with the device, such as a tap, text entry, wait, etc.", "id": "GoogleFirebaseAppdistroV1alphaDeviceInteraction", "properties": { +"enterText": { +"$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteractionEnterText", +"description": "Output only. A text entry action, that enters text into a particular text field, clearing any existing text in the field. Unlike `text_input` this action does not require any other actions such as a tap to be performed before it can enter the text.", +"readOnly": true +}, "keyCode": { "description": "Output only. Key code for a key event action.", "readOnly": true, @@ -1309,7 +1337,7 @@ "readOnly": true }, "textInput": { -"description": "Output only. Text entered for a text entry action.", +"description": "Output only. A text input action, that types some text into whatever field is currently focused, if any. Unlike `enter_text` this action requires that the field be brought into focus first, for example by emitting a tap action before this one.", "readOnly": true, "type": "string" }, @@ -1321,6 +1349,23 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaDeviceInteractionEnterText": { +"description": "A text entry action, that enters text into a particular text field, clearing any existing text in the field.", +"id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionEnterText", +"properties": { +"elementBounds": { +"$ref": "AndroidxCrawlerOutputRectangle", +"description": "Output only. The visible bounds of the element to enter text into.", +"readOnly": true +}, +"text": { +"description": "Output only. The text to enter.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe": { "description": "A swipe action.", "id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 2aea97f57b..fdac55495e 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250604", +"revision": "20250610", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -407,7 +407,7 @@ "type": "string" }, "displayName": { -"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", +"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", "type": "string" }, "mimeType": { @@ -455,6 +455,10 @@ "PROHIBITED_CONTENT", "SPII", "MALFORMED_FUNCTION_CALL", +"IMAGE_SAFETY", +"IMAGE_PROHIBITED_CONTENT", +"IMAGE_RECITATION", +"IMAGE_OTHER", "UNEXPECTED_TOOL_CALL" ], "enumDescriptions": [ @@ -468,6 +472,10 @@ "Token generation stopped for potentially containing prohibited content.", "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid.", +"Token generation stopped because generated images has safety violations.", +"Image generation stopped because generated images has other prohibited content.", +"Image generation stopped due to recitation.", +"Image generation stopped because of other miscellaneous issue.", "The tool call generated by the model is invalid." ], "readOnly": true, @@ -795,7 +803,7 @@ "id": "GoogleCloudAiplatformV1beta1FileData", "properties": { "displayName": { -"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.", +"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", "type": "string" }, "fileUri": { @@ -1018,14 +1026,16 @@ "SAFETY", "OTHER", "BLOCKLIST", -"PROHIBITED_CONTENT" +"PROHIBITED_CONTENT", +"IMAGE_SAFETY" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", "Candidates blocked due to other reason.", "Candidates blocked due to the terms which are included from the terminology blocklist.", -"Candidates blocked due to prohibited content." +"Candidates blocked due to prohibited content.", +"Candidates blocked due to unsafe image generation content." ], "readOnly": true, "type": "string" @@ -1835,7 +1845,11 @@ "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", -"HARM_CATEGORY_CIVIC_INTEGRITY" +"HARM_CATEGORY_CIVIC_INTEGRITY", +"HARM_CATEGORY_IMAGE_HATE", +"HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", +"HARM_CATEGORY_IMAGE_HARASSMENT", +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" ], "enumDeprecated": [ false, @@ -1843,7 +1857,11 @@ false, false, false, false, -true +true, +false, +false, +false, +false ], "enumDescriptions": [ "The harm category is unspecified.", @@ -1851,7 +1869,32 @@ true "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", -"Deprecated: Election filter is not longer supported. The harm category is civic integrity." +"Deprecated: Election filter is not longer supported. The harm category is civic integrity.", +"The harm category is image hate.", +"The harm category is image dangerous content.", +"The harm category is image harassment.", +"The harm category is image sexually explicit content." +], +"readOnly": true, +"type": "string" +}, +"overwrittenThreshold": { +"description": "Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.", +"enum": [ +"HARM_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_ONLY_HIGH", +"BLOCK_NONE", +"OFF" +], +"enumDescriptions": [ +"Unspecified harm block threshold.", +"Block low threshold and above (i.e. block more).", +"Block medium threshold and above.", +"Block only high threshold (i.e. block less).", +"Block none.", +"Turn off the safety filter." ], "readOnly": true, "type": "string" @@ -1921,7 +1964,11 @@ true "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", -"HARM_CATEGORY_CIVIC_INTEGRITY" +"HARM_CATEGORY_CIVIC_INTEGRITY", +"HARM_CATEGORY_IMAGE_HATE", +"HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", +"HARM_CATEGORY_IMAGE_HARASSMENT", +"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT" ], "enumDeprecated": [ false, @@ -1929,7 +1976,11 @@ false, false, false, false, -true +true, +false, +false, +false, +false ], "enumDescriptions": [ "The harm category is unspecified.", @@ -1937,7 +1988,11 @@ true "The harm category is dangerous content.", "The harm category is harassment.", "The harm category is sexually explicit content.", -"Deprecated: Election filter is not longer supported. The harm category is civic integrity." +"Deprecated: Election filter is not longer supported. The harm category is civic integrity.", +"The harm category is image hate.", +"The harm category is image dangerous content.", +"The harm category is image harassment.", +"The harm category is image sexually explicit content." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index 62ff3872ee..2e7269270f 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -2042,6 +2042,11 @@ "location": "query", "type": "string" }, +"ignoreErrors": { +"description": "Optional. If set to true, the unenrollment of a vmware admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Required. Name of the VMware admin cluster to be unenrolled. Format: \"projects/{project}/locations/{location}/vmwareAdminClusters/{cluster}\"", "location": "path", @@ -3100,7 +3105,7 @@ } } }, -"revision": "20250519", +"revision": "20250606", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 93c485f89f..cae3cbd371 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4676,6 +4676,11 @@ "parent" ], "parameters": { +"enableNaturalLanguageQueryUnderstanding": { +"description": "Optional. Whether to enable natural language query understanding.", +"location": "query", +"type": "boolean" +}, "filter": { "description": "Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, \"status=\\\"ACTIVE\\\"", "location": "query", @@ -4704,6 +4709,11 @@ "required": true, "type": "string" }, +"query": { +"description": "Optional. The search query that will be passed to Vertex search service.", +"location": "query", +"type": "string" +}, "readMask": { "description": "Optional. The mask which specifies fields that need to be returned in the template's response.", "format": "google-fieldmask", @@ -4838,7 +4848,7 @@ } } }, -"revision": "20250521", +"revision": "20250610", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -10183,7 +10193,7 @@ false "type": "object" }, "GoogleCloudConnectorsV1EventingConfig": { -"description": "Eventing Configuration of a connection next: 18", +"description": "Eventing Configuration of a connection next: 19", "id": "GoogleCloudConnectorsV1EventingConfig", "properties": { "additionalVariables": { @@ -10217,6 +10227,13 @@ false "$ref": "GoogleCloudConnectorsV1AuthConfig", "description": "Optional. Auth details for the event listener." }, +"privateConnectivityAllowlistedProjects": { +"description": "Optional. List of projects to be allowlisted for the service attachment created in the tenant project for eventing ingress.", +"items": { +"type": "string" +}, +"type": "array" +}, "privateConnectivityEnabled": { "description": "Optional. Private Connectivity Enabled.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index af01ca6055..9150f082f4 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -710,7 +710,7 @@ } } }, -"revision": "20250414", +"revision": "20250604", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1505,9 +1505,16 @@ "type": "string" }, "localFqdn": { -"description": "Required. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", +"description": "Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.", "type": "string" }, +"localFqdns": { +"description": "Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.", +"items": { +"type": "string" +}, +"type": "array" +}, "targetServiceAttachmentUri": { "description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 47675be17b..076fc4f69e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -181,7 +181,7 @@ ] }, "list": { -"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an advanced account, but all accounts the calling user has access to including other advanced accounts, linked accounts, standalone accounts and so on. If no filter is provided, then it returns all the accounts the user has access to. This method is eventually consistent, meaning changes such as creating, updating an account or a change of relationships between accounts may not show up in the results immediately. Instead, these changes propagate over a short period, after which the updated information can match the associated predicates. That means, that searching by account name might not return a recently changed account even though it satisfies the predicate.", +"description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", "flatPath": "accounts/v1beta/accounts", "httpMethod": "GET", "id": "merchantapi.accounts.list", @@ -602,7 +602,7 @@ "gbpAccounts": { "methods": { "linkGbpAccount": { -"description": "Link the specified merchant to a GBP account for all countries.", +"description": "Link the specified merchant to a GBP account for all countries. To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message `User is not an administrator of account {ACCOUNT_ID}`.", "flatPath": "accounts/v1beta/accounts/{accountsId}/gbpAccounts:linkGbpAccount", "httpMethod": "POST", "id": "merchantapi.accounts.gbpAccounts.linkGbpAccount", @@ -1824,7 +1824,7 @@ ] }, "retrieveForApplication": { -"description": "Retrieves the state of the agreement for the application terms of service.", +"description": "Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.", "flatPath": "accounts/v1beta/accounts/{accountsId}/termsOfServiceAgreementStates:retrieveForApplication", "httpMethod": "GET", "id": "merchantapi.accounts.termsOfServiceAgreementStates.retrieveForApplication", @@ -2108,7 +2108,7 @@ } } }, -"revision": "20250603", +"revision": "20250611", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2157,16 +2157,16 @@ "id": "Accepted", "properties": { "acceptedBy": { -"description": "The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account.", +"description": "Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account.", "type": "string" }, "termsOfService": { -"description": "The accepted termsOfService.", +"description": "Required. The accepted termsOfService.", "type": "string" }, "validUntil": { "$ref": "Date", -"description": "When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message." +"description": "Optional. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message." } }, "type": "object" @@ -3947,7 +3947,7 @@ false "id": "PhoneNumber", "properties": { "e164Number": { -"description": "The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: \"+15552220123\" - incorrect: \"+1 (555) 222-01234 x123\". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes", +"description": "The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting. For example: - correct: \"+15552220123\" - incorrect: \"+1 (555) 222-01234 x123\" The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes", "type": "string" }, "extension": { @@ -3956,7 +3956,7 @@ false }, "shortCode": { "$ref": "ShortCode", -"description": "A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code" +"description": "A short code. Reference(s): - https://wikipedia.org/wiki/Short_code" } }, "type": "object" @@ -4447,11 +4447,11 @@ false "id": "Required", "properties": { "termsOfService": { -"description": "The `TermsOfService` that need to be accepted.", +"description": "Required. The `TermsOfService` that need to be accepted.", "type": "string" }, "tosFileUri": { -"description": "Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only.", +"description": "Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only.", "type": "string" } }, @@ -4641,7 +4641,7 @@ false "id": "ShippingSettings", "properties": { "etag": { -"description": "Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps\uff1a 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.", +"description": "Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag.", "type": "string" }, "name": { @@ -4801,22 +4801,22 @@ false "properties": { "accepted": { "$ref": "Accepted", -"description": "The accepted terms of service of this kind and for the associated region_code" +"description": "Optional. The accepted terms of service of this kind and for the associated region_code" }, "name": { "description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`.", "type": "string" }, "regionCode": { -"description": "Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.", +"description": "Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to.", "type": "string" }, "required": { "$ref": "Required", -"description": "The required terms of service" +"description": "Optional. The required terms of service" }, "termsOfServiceKind": { -"description": "Terms of Service kind associated with the particular version.", +"description": "Required. Terms of Service kind associated with the particular version.", "enum": [ "TERMS_OF_SERVICE_KIND_UNSPECIFIED", "MERCHANT_CENTER" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index ed934b7f7e..e3f7ea6622 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -281,7 +281,7 @@ } } }, -"revision": "20250605", +"revision": "20250606", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1266,7 +1266,7 @@ false "type": "string" }, "feedLabel": { -"description": "Output only. The feed label for the product.", +"description": "Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters are`A-Z`, `0-9`, hyphen and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087)", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ml.v1.json b/googleapiclient/discovery_cache/documents/ml.v1.json index 7377cab279..18b7ffebe0 100644 --- a/googleapiclient/discovery_cache/documents/ml.v1.json +++ b/googleapiclient/discovery_cache/documents/ml.v1.json @@ -1486,7 +1486,7 @@ } } }, -"revision": "20241116", +"revision": "20250503", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 0d4acbf0ba..43e594b483 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, -"revision": "20250319", +"revision": "20250615", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { @@ -844,7 +844,7 @@ "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 463e711cf4..3e3207d130 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20250319", +"revision": "20250615", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1387,7 +1387,7 @@ "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index fa7b843828..7da5b2561d 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -237,7 +237,7 @@ } } }, -"revision": "20250319", +"revision": "20250615", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { @@ -370,7 +370,7 @@ "type": "object" }, "PostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index d2b9c98ee3..19b5cb0caa 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2270,7 +2270,7 @@ } } }, -"revision": "20250528", +"revision": "20250604", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4041,6 +4041,10 @@ "description": "Optional. Description of the storage pool", "type": "string" }, +"enableHotTierAutoResize": { +"description": "Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.", +"type": "boolean" +}, "encryptionType": { "description": "Output only. Specifies the current pool encryption key source.", "enum": [ @@ -4061,6 +4065,11 @@ "description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions.", "type": "boolean" }, +"hotTierSizeGib": { +"description": "Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.", +"format": "int64", +"type": "string" +}, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4200,6 +4209,10 @@ "format": "int32", "type": "integer" }, +"hotTierBypassModeEnabled": { +"description": "Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.", +"type": "boolean" +}, "tierAction": { "description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 56e4a03d22..a2fae8e488 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -105,6 +105,211 @@ }, "protocol": "rest", "resources": { +"organizations": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "networkmanagement.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.", +"flatPath": "v1/organizations/{organizationsId}/locations", +"httpMethod": "GET", +"id": "networkmanagement.organizations.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"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": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "networkmanagement.organizations.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"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": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "networkmanagement.organizations.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"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": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "networkmanagement.organizations.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"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": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "networkmanagement.organizations.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, "projects": { "resources": { "locations": { @@ -764,7 +969,7 @@ } } }, -"revision": "20250527", +"revision": "20250604", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1062,6 +1267,11 @@ false "description": "Wrapper for Cloud Run revision attributes.", "id": "CloudRunRevisionEndpoint", "properties": { +"serviceUri": { +"description": "Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}", +"readOnly": true, +"type": "string" +}, "uri": { "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision}", "type": "string" @@ -2040,7 +2250,8 @@ false "type": "string" }, "running": { -"description": "Indicates whether the Compute Engine instance is running.", +"deprecated": true, +"description": "Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead.", "type": "boolean" }, "serviceAccount": { @@ -2048,6 +2259,20 @@ false "description": "Service account authorized for the instance.", "type": "string" }, +"status": { +"description": "The status of the instance.", +"enum": [ +"STATUS_UNSPECIFIED", +"RUNNING", +"NOT_RUNNING" +], +"enumDescriptions": [ +"Default unspecified value.", +"The instance is running.", +"The instance has any status other than \"RUNNING\"." +], +"type": "string" +}, "uri": { "description": "URI of a Compute Engine instance.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 74385484bc..1eed2a8ac6 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1161,12 +1161,12 @@ "parent": { "description": "Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}:queryOrgVpcFlowLogsConfigs", +"path": "v1beta1/{+parent}/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs", "response": { "$ref": "QueryOrgVpcFlowLogsConfigsResponse" }, @@ -1181,7 +1181,7 @@ } } }, -"revision": "20250527", +"revision": "20250604", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1479,6 +1479,11 @@ false "description": "Wrapper for Cloud Run revision attributes.", "id": "CloudRunRevisionEndpoint", "properties": { +"serviceUri": { +"description": "Output only. The URI of the Cloud Run service that the revision belongs to. The format is: projects/{project}/locations/{location}/services/{service}", +"readOnly": true, +"type": "string" +}, "uri": { "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) URI. The format is: projects/{project}/locations/{location}/revisions/{revision}", "type": "string" @@ -2461,7 +2466,8 @@ false "type": "string" }, "running": { -"description": "Indicates whether the Compute Engine instance is running.", +"deprecated": true, +"description": "Indicates whether the Compute Engine instance is running. Deprecated: use the `status` field instead.", "type": "boolean" }, "serviceAccount": { @@ -2469,6 +2475,20 @@ false "description": "Service account authorized for the instance.", "type": "string" }, +"status": { +"description": "The status of the instance.", +"enum": [ +"STATUS_UNSPECIFIED", +"RUNNING", +"NOT_RUNNING" +], +"enumDescriptions": [ +"Default unspecified value.", +"The instance is running.", +"The instance has any status other than \"RUNNING\"." +], +"type": "string" +}, "uri": { "description": "URI of a Compute Engine instance.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index 5ca28d2f39..c2b6aa928e 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -2014,6 +2014,168 @@ } } }, +"backendAuthenticationConfigs": { +"methods": { +"create": { +"description": "Creates a new BackendAuthenticationConfig in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.backendAuthenticationConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backendAuthenticationConfigId": { +"description": "Required. Short name of the BackendAuthenticationConfig 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. \"backend-auth-config\".", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the BackendAuthenticationConfig. Must be in the format `projects/*/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backendAuthenticationConfigs", +"request": { +"$ref": "BackendAuthenticationConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single BackendAuthenticationConfig to BackendAuthenticationConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.backendAuthenticationConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. A name of the BackendAuthenticationConfig to delete. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single BackendAuthenticationConfig to BackendAuthenticationConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.backendAuthenticationConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the BackendAuthenticationConfig to get. Must be in the format `projects/*/locations/{location}/backendAuthenticationConfigs/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackendAuthenticationConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackendAuthenticationConfigs in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.backendAuthenticationConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of BackendAuthenticationConfigs to return per call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The value returned by the last `ListBackendAuthenticationConfigsResponse` Indicates that this is a continuation of a prior `ListBackendAuthenticationConfigs` call, and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the BackendAuthenticationConfigs should be listed, specified in the format `projects/*/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backendAuthenticationConfigs", +"response": { +"$ref": "ListBackendAuthenticationConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single BackendAuthenticationConfig to BackendAuthenticationConfig.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.backendAuthenticationConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backendAuthenticationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the BackendAuthenticationConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackendAuthenticationConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "clientTlsPolicies": { "methods": { "create": { @@ -4908,7 +5070,7 @@ } } }, -"revision": "20250527", +"revision": "20250604", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5461,6 +5623,67 @@ }, "type": "object" }, +"BackendAuthenticationConfig": { +"description": "BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer\u2019s BackendService directly determining how that BackendService negotiates TLS.", +"id": "BackendAuthenticationConfig", +"properties": { +"clientCertificate": { +"description": "Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form \"projects/{project}/locations/{location}/certificates/{certificate}\". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.", +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Free-text description of the resource.", +"type": "string" +}, +"etag": { +"description": "Output only. Etag of the resource.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Set of label tags associated with the resource.", +"type": "object" +}, +"name": { +"description": "Required. Name of the BackendAuthenticationConfig resource. It matches the pattern `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}`", +"type": "string" +}, +"trustConfig": { +"description": "Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form \"projects/{project}/locations/{location}/trustConfigs/{trust_config}\". A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"wellKnownRoots": { +"description": "Well known roots to use for server certificate validation.", +"enum": [ +"WELL_KNOWN_ROOTS_UNSPECIFIED", +"NONE", +"PUBLIC_ROOTS" +], +"enumDescriptions": [ +"Equivalent to NONE.", +"The BackendService will only validate server certificates against roots specified in TrustConfig.", +"The BackendService uses a set of well-known public roots, in addition to any roots specified in the trustConfig field, when validating the server certificates presented by the backend. Validation with these roots is only considered when the TlsSettings.sni field in the BackendService is set. The well-known roots are a set of root CAs managed by Google. CAs in this set can be added or removed without notice." +], +"type": "string" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -6663,6 +6886,31 @@ }, "type": "object" }, +"ListBackendAuthenticationConfigsResponse": { +"description": "Response returned by the ListBackendAuthenticationConfigs method.", +"id": "ListBackendAuthenticationConfigsResponse", +"properties": { +"backendAuthenticationConfigs": { +"description": "List of BackendAuthenticationConfig resources.", +"items": { +"$ref": "BackendAuthenticationConfig" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListClientTlsPoliciesResponse": { "description": "Response returned by the ListClientTlsPolicies method.", "id": "ListClientTlsPoliciesResponse", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index e7a57f7942..afc231a8df 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -4509,7 +4509,7 @@ ], "parameters": { "parent": { -"description": "Required. Value for parent.", +"description": "Required. The parent, in the form `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4521,7 +4521,7 @@ "type": "string" }, "sacAttachmentId": { -"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and sac_attachment_id from the method_signature of Create RPC", +"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" } @@ -4538,7 +4538,7 @@ ] }, "delete": { -"description": "Deletes a single SACAttachment.", +"description": "Deletes the specified attachment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/sacAttachments/{sacAttachmentsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.sacAttachments.delete", @@ -4547,7 +4547,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sacAttachments/[^/]+$", "required": true, @@ -4568,7 +4568,7 @@ ] }, "get": { -"description": "Gets details of a single SACAttachment.", +"description": "Returns the specified attachment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/sacAttachments/{sacAttachmentsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.sacAttachments.get", @@ -4577,7 +4577,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sacAttachments/[^/]+$", "required": true, @@ -4602,12 +4602,12 @@ ], "parameters": { "filter": { -"description": "Optional. Filtering results", +"description": "Optional. An expression that filters the list of results.", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Hint for how to order the results", +"description": "Optional. Sort the results by a certain order.", "location": "query", "type": "string" }, @@ -4623,7 +4623,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent value for ListSACAttachmentsRequest", +"description": "Required. The parent, in the form `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4652,7 +4652,7 @@ ], "parameters": { "parent": { -"description": "Required. Value for parent.", +"description": "Required. The parent, in the form `projects/{project}/locations/global`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4664,7 +4664,7 @@ "type": "string" }, "sacRealmId": { -"description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and sac_realm_id from the method_signature of Create RPC", +"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" } @@ -4681,7 +4681,7 @@ ] }, "delete": { -"description": "Deletes a single SACRealm.", +"description": "Deletes the specified realm.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/sacRealms/{sacRealmsId}", "httpMethod": "DELETE", "id": "networksecurity.projects.locations.sacRealms.delete", @@ -4690,7 +4690,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sacRealms/[^/]+$", "required": true, @@ -4711,7 +4711,7 @@ ] }, "get": { -"description": "Gets details of a single SACRealm.", +"description": "Returns the specified realm.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/sacRealms/{sacRealmsId}", "httpMethod": "GET", "id": "networksecurity.projects.locations.sacRealms.get", @@ -4720,7 +4720,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource", +"description": "Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sacRealms/[^/]+$", "required": true, @@ -4745,12 +4745,12 @@ ], "parameters": { "filter": { -"description": "Optional. Filtering results", +"description": "Optional. An expression that filters the list of results.", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Hint for how to order the results", +"description": "Optional. Sort the results by a certain order.", "location": "query", "type": "string" }, @@ -4766,7 +4766,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent value for ListSACRealmsRequest", +"description": "Required. The parent, in the form `projects/{project}/locations/global`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -5356,7 +5356,7 @@ } } }, -"revision": "20250527", +"revision": "20250604", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -7510,7 +7510,7 @@ "type": "object" }, "ListSACAttachmentsResponse": { -"description": "Message for response to listing SACAttachments", +"description": "Response for `ListSACAttachments` method.", "id": "ListSACAttachmentsResponse", "properties": { "nextPageToken": { @@ -7518,7 +7518,7 @@ "type": "string" }, "sacAttachments": { -"description": "The list of SACAttachments", +"description": "The list of SACAttachments.", "items": { "$ref": "SACAttachment" }, @@ -7535,7 +7535,7 @@ "type": "object" }, "ListSACRealmsResponse": { -"description": "Message for response to listing SACRealms", +"description": "Response for `ListSACRealms` method.", "id": "ListSACRealmsResponse", "properties": { "nextPageToken": { @@ -7543,7 +7543,7 @@ "type": "string" }, "sacRealms": { -"description": "The list of SACRealms", +"description": "The list of SACRealms.", "items": { "$ref": "SACRealm" }, @@ -8332,15 +8332,15 @@ "type": "object" }, "SACAttachment": { -"description": "Configuration for an attachment within a SAC realm.", +"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": { "country": { -"description": "Optional. ISO-3166 alpha 2 country code used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Not case-sensitive, since it will be upper-cased when sending to Symantec API.", +"description": "Optional. Case-insensitive ISO-3166 alpha-2 country code used for localization. Only valid for Symantec attachments.", "type": "string" }, "createTime": { -"description": "Output only. [Output only] Timestamp when the attachment was created.", +"description": "Output only. Timestamp when the attachment was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8357,15 +8357,15 @@ "type": "string" }, "nccGateway": { -"description": "Required. Name of the NCC Gateway which connects to the attachment. ID or full URI can be specified. Full URI is stored either way\uff0cin the form `projects/{project}/locations/{location}/spokes/{ncc_gateway}`.", +"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. Name of the SAC Realm which owns the attachment. The input can be either an ID for a full name. The output will always be the full name using project number instead of project ID. The format is `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.", +"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. [Output only] State of the attachment.", +"description": "Output only. State of the attachment.", "enum": [ "STATE_UNSPECIFIED", "PENDING_PARTNER_ATTACHMENT", @@ -8383,14 +8383,14 @@ }, "symantecOptions": { "$ref": "SACAttachmentSACAttachmentSymantecOptions", -"description": "Optional. Required iff the associated realm is of type SYMANTEC_CLOUD_SWG." +"description": "Optional. Configuration required for Symantec attachments." }, "timeZone": { -"description": "Optional. tzinfo identifier used for localization. Only used for Symantec's API today, and is optional even for gateways connected to Symantec, since Symantec applies a default if we don't specify it. Case sensitive.", +"description": "Optional. Case-sensitive tzinfo identifier used for localization. Only valid for Symantec attachments.", "type": "string" }, "updateTime": { -"description": "Output only. [Output only] Timestamp when the attachment was last updated.", +"description": "Output only. Timestamp when the attachment was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8399,26 +8399,26 @@ "type": "object" }, "SACAttachmentSACAttachmentSymantecOptions": { -"description": "Fields specific to SSEGWs connecting to Symantec Cloud SWG.", +"description": "Fields specific to attachments associated with Symantec Cloud SWG.", "id": "SACAttachmentSACAttachmentSymantecOptions", "properties": { "symantecLocationName": { -"description": "Immutable. Name to be used for when creating a Location on the customer's behalf in Symantec's Location API. Required iff sac_realm uses SYMANTEC_CLOUD_SWG. Not to be confused with GCP locations.", +"description": "Immutable. Name to be used when creating a location on the customer's behalf in Symantec's Location API. Not to be confused with GCP locations.", "type": "string" }, "symantecSite": { -"description": "Immutable. Symantec data center identifier that this Attachment will connect to. Required iff sac_realm uses SYMANTEC_CLOUD_SWG.", +"description": "Immutable. Symantec data center identifier that this attachment will connect to.", "type": "string" } }, "type": "object" }, "SACRealm": { -"description": "Message describing SACRealm object", +"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. [Output only] Create time stamp", +"description": "Output only. Timestamp when the realm was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8427,20 +8427,20 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Labels as key value pairs", +"description": "Optional. Optional list of labels applied to the resource.", "type": "object" }, "name": { -"description": "Identifier. Resource name. It matches the pattern `projects/{project}/locations/{location}/sacRealms/{sacRealm}`", +"description": "Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", "type": "string" }, "pairingKey": { "$ref": "SACRealmPairingKey", -"description": "Output only. [Output only] Key to be shared with SSE service provider to establish global handshake", +"description": "Output only. Key to be shared with SSE service provider during pairing.", "readOnly": true }, "securityService": { -"description": "Immutable. SSE service provider", +"description": "Immutable. SSE service provider associated with the realm.", "enum": [ "SECURITY_SERVICE_UNSPECIFIED", "PALO_ALTO_PRISMA_ACCESS", @@ -8454,7 +8454,7 @@ "type": "string" }, "state": { -"description": "Output only. [Output only] State of the realm", +"description": "Output only. State of the realm.", "enum": [ "STATE_UNSPECIFIED", "PENDING_PARTNER_ATTACHMENT", @@ -8463,21 +8463,21 @@ "KEY_EXPIRED" ], "enumDescriptions": [ -"The default value. This value is used if the state is omitted.", -"This realm has never been attached to a partner realm. Used only for Prisma Access.", -"This realm is currently attached to a partner.", -"This realm was once attached to a partner but has been detached.", -"This realm is not attached to a partner realm, and its pairing key has expired and needs key regeneration. Used only for Prisma Access." +"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" }, "symantecOptions": { "$ref": "SACRealmSACRealmSymantecOptions", -"description": "Optional. Required only if using SYMANTEC_CLOUD_SWG." +"description": "Optional. Configuration required for Symantec realms." }, "updateTime": { -"description": "Output only. [Output only] Update time stamp", +"description": "Output only. Timestamp when the realm was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8486,17 +8486,17 @@ "type": "object" }, "SACRealmPairingKey": { -"description": "Key to be shared with SSE service provider to establish global handshake", +"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.", +"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. The name of the key. It expires 7 days after creation.", +"description": "Output only. Key value.", "readOnly": true, "type": "string" } @@ -8504,11 +8504,11 @@ "type": "object" }, "SACRealmSACRealmSymantecOptions": { -"description": "Fields specific to realms using SYMANTEC_CLOUD_SWG.", +"description": "Fields specific to realms using Symantec Cloud SWG.", "id": "SACRealmSACRealmSymantecOptions", "properties": { "availableSymantecSites": { -"description": "Output only. Symantec site IDs that the user can choose to connect to.", +"description": "Output only. Symantec site IDs which the user can choose to connect to.", "items": { "type": "string" }, @@ -8516,11 +8516,11 @@ "type": "array" }, "secretPath": { -"description": "Optional. API Key used to call Symantec APIs on the user's behalf. Required if using SYMANTEC_CLOUD_SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as secret URI in the format of \"projects/{PROJECT_NUMBER}/secrets/my-secret\".", +"description": "Optional. API Key used to call Symantec APIs on the user's behalf. Required if using Symantec Cloud SWG. P4SA account needs permissions granted to read this secret. A secret ID, secret name, or secret URI can be specified, but it will be parsed and stored as a secret URI in the form `projects/{project_number}/secrets/my-secret`.", "type": "string" }, "symantecConnectionState": { -"description": "Output only. [Output only] Connection status to Symantec API.", +"description": "Output only. Connection status to Symantec API.", "enum": [ "SYMANTEC_CONNECTION_STATE_UNSPECIFIED", "SUCCEEDED", @@ -8528,9 +8528,9 @@ "REQUEST_TO_SYMANTEC_FAILED" ], "enumDescriptions": [ -"The default value. This value is used if the state is omitted.", +"No state specified. This should not be used.", "Successfully made a request to Symantec API.", -"Cannot access the API key in the provided secret_path.", +"Cannot access the API key in the provided `secret_path`.", "Failed to get a successful response from Symantec API due to an invalid API key or Symantec API unavailability." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 7a9a0803da..9214610225 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -332,7 +332,7 @@ ] }, "getConfig": { -"description": "Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.", +"description": "Returns various configuration parameters.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances:getConfig", "httpMethod": "GET", "id": "notebooks.projects.locations.instances.getConfig", @@ -910,7 +910,7 @@ } } }, -"revision": "20250528", +"revision": "20250604", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 5a2bcd854a..f4ddbf6493 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -930,7 +930,7 @@ } } }, -"revision": "20250418", +"revision": "20250606", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1355,7 +1355,7 @@ "type": "boolean" }, "enforce": { -"description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints.", +"description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.", "type": "boolean" }, "parameters": { diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index db30d5f587..dd3364c891 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20250506", +"revision": "20250611", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1557,7 +1557,7 @@ "type": "boolean" }, "periods": { -"description": "The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations.", +"description": "NOTE: The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day.", "items": { "$ref": "GoogleMapsPlacesV1PlaceOpeningHoursPeriod" }, @@ -1607,7 +1607,7 @@ "type": "array" }, "weekdayDescriptions": { -"description": "Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: \"Sun: 18:00\u201306:00\"", +"description": "Localized strings describing the opening hours of this place, one string for each day of the week. NOTE: The order of the days and the start of the week is determined by the locale (language and region). The ordering of the `periods` array is independent of the ordering of the `weekday_descriptions` array. Do not assume they will begin on the same day. Will be empty if the hours are unknown or could not be converted to localized text. Example: \"Sun: 18:00\u201306:00\"", "items": { "type": "string" }, @@ -2369,7 +2369,7 @@ "type": "object" }, "GoogleTypePostalAddress": { -"description": "Represents a postal address (for example, for postal delivery or payments addresses). Given a postal address, a postal service can deliver items to a premise, P.O. box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "GoogleTypePostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 3b351e2301..f3c2665e94 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -942,7 +942,7 @@ } } }, -"revision": "20250601", +"revision": "20250606", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1110,7 +1110,7 @@ "type": "boolean" }, "enforce": { -"description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints.", +"description": "If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set in policies for boolean constraints, custom constraints and managed constraints.", "type": "boolean" }, "parameters": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index adc8c73244..d2c15e518e 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20241015", +"revision": "20250611", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { @@ -254,6 +254,21 @@ "description": "Output only. The resource name of the reader. The last part of ppid in the resource name is the publisher provided id.", "readOnly": true, "type": "string" +}, +"originatingPublicationId": { +"description": "Output only. The SwG publication id that the reader's subscription linking was originating from.", +"readOnly": true, +"type": "string" +}, +"ppid": { +"description": "Output only. The publisher provided id of the reader.", +"readOnly": true, +"type": "string" +}, +"publicationId": { +"description": "Output only. The SwG publication id that the reader has linked their subscription to.", +"readOnly": true, +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 83ad4aacfa..43b6052b64 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -350,7 +350,7 @@ "keys": { "methods": { "addIpOverride": { -"description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.", +"description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.", "flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride", "httpMethod": "POST", "id": "recaptchaenterprise.projects.keys.addIpOverride", @@ -786,7 +786,7 @@ } } }, -"revision": "20250518", +"revision": "20250608", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 6c856415e1..5d5df63f5e 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250527", +"revision": "20250609", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1887,7 +1887,7 @@ "type": "object" }, "DatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8", "id": "DatabaseResourceFeed", "properties": { "feedTimestamp": { @@ -1965,6 +1965,10 @@ "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", "type": "string" }, +"location": { +"description": "This is used to identify the location of the resource. Example: \"us-central1\"", +"type": "string" +}, "name": { "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", "type": "string" @@ -2388,7 +2392,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4208,6 +4212,7 @@ false "PRODUCT_TYPE_BIGTABLE", "PRODUCT_TYPE_FIRESTORE", "PRODUCT_TYPE_COMPUTE_ENGINE", +"PRODUCT_TYPE_ORACLE_ON_GCP", "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ @@ -4223,6 +4228,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4238,6 +4244,7 @@ false "Bigtable product area in GCP", "Firestore product area in GCP.", "Compute Engine self managed databases", +"Oracle product area in GCP", "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" @@ -4360,7 +4367,7 @@ false "type": "string" }, "port": { -"description": "Output only. The port number of the exposed discovery endpoint.", +"description": "Output only. port will only be set for Primary/Reader or Discovery endpoint.", "format": "int32", "readOnly": true, "type": "integer" @@ -4587,6 +4594,7 @@ false "type": "string" }, "timeBasedRetention": { +"deprecated": true, "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 87f6cd0d10..e24abf0ffd 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1073,7 +1073,7 @@ } } }, -"revision": "20250527", +"revision": "20250609", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1887,7 +1887,7 @@ "type": "object" }, "DatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8", "id": "DatabaseResourceFeed", "properties": { "feedTimestamp": { @@ -1965,6 +1965,10 @@ "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", "type": "string" }, +"location": { +"description": "This is used to identify the location of the resource. Example: \"us-central1\"", +"type": "string" +}, "name": { "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", "type": "string" @@ -2388,7 +2392,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/cloudExadataInfrastructures oracledatabase.googleapis.com/cloudVmClusters oracledatabase.googleapis.com/autonomousDatabases spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4215,6 +4219,7 @@ false "PRODUCT_TYPE_BIGTABLE", "PRODUCT_TYPE_FIRESTORE", "PRODUCT_TYPE_COMPUTE_ENGINE", +"PRODUCT_TYPE_ORACLE_ON_GCP", "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ @@ -4230,6 +4235,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4245,6 +4251,7 @@ false "Bigtable product area in GCP", "Firestore product area in GCP.", "Compute Engine self managed databases", +"Oracle product area in GCP", "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" @@ -4367,7 +4374,7 @@ false "type": "string" }, "port": { -"description": "Output only. The port number of the exposed discovery endpoint.", +"description": "Output only. port will only be set for Primary/Reader or Discovery endpoint.", "format": "int32", "readOnly": true, "type": "integer" @@ -4594,6 +4601,7 @@ false "type": "string" }, "timeBasedRetention": { +"deprecated": true, "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 8be380c2d8..809f4538fb 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2800,7 +2800,7 @@ } } }, -"revision": "20250522", +"revision": "20250605", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4592,6 +4592,13 @@ "$ref": "GoogleCloudRetailV2alphaUserInfo", "description": "Optional. User information." }, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, "visitorId": { "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" @@ -7306,6 +7313,10 @@ "description": "The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.", "type": "string" }, +"experimentId": { +"description": "Optional. An ID for the experiment group this search belongs to.", +"type": "string" +}, "facetSpecs": { "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index e4a893dd0c..cb7f86e74d 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2887,7 +2887,7 @@ } } }, -"revision": "20250509", +"revision": "20250606", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4574,7 +4574,7 @@ false "id": "GoogleDevtoolsCloudbuildV1GitSourceRepository", "properties": { "developerConnect": { -"description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", +"description": "The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", "type": "string" }, "url": { @@ -6654,13 +6654,18 @@ false "id": "TaskAttemptResult", "properties": { "exitCode": { -"description": "Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details.", +"description": "Optional. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set.", "format": "int32", "type": "integer" }, "status": { "$ref": "GoogleRpcStatus", "description": "Optional. The status of this attempt. If the status code is OK, then the attempt succeeded." +}, +"termSignal": { +"description": "Optional. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 69a4e0c92a..59bb2d5fb4 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1922,7 +1922,7 @@ } } }, -"revision": "20250509", +"revision": "20250606", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -4339,7 +4339,7 @@ "id": "GoogleCloudRunV2TaskAttemptResult", "properties": { "exitCode": { -"description": "Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details.", +"description": "Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details. At most one of exit_code or term_signal will be set.", "format": "int32", "readOnly": true, "type": "integer" @@ -4348,6 +4348,12 @@ "$ref": "GoogleRpcStatus", "description": "Output only. The status of this attempt. If the status code is OK, then the attempt succeeded.", "readOnly": true +}, +"termSignal": { +"description": "Output only. Termination signal of the container. This is set to non-zero if the container is terminated by the system. At most one of exit_code or term_signal will be set.", +"format": "int32", +"readOnly": true, +"type": "integer" } }, "type": "object" @@ -4831,10 +4837,6 @@ "$ref": "GoogleCloudRunV2ServiceMesh", "description": "Optional. Enables service mesh connectivity." }, -"sessionAffinity": { -"description": "Optional. Enable session affinity.", -"type": "boolean" -}, "volumes": { "description": "Optional. A list of Volumes to make available to containers.", "items": { @@ -5726,7 +5728,7 @@ false "id": "GoogleDevtoolsCloudbuildV1GitSourceRepository", "properties": { "developerConnect": { -"description": "The Developer Connect Git repository link or the url that matches a repository link in the current project, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", +"description": "The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`", "type": "string" }, "url": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 0e838929fd..0f50f9855b 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -5938,7 +5938,7 @@ } } }, -"revision": "20250519", +"revision": "20250609", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6054,6 +6054,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -7374,6 +7419,25 @@ }, "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 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", @@ -7763,6 +7827,10 @@ "$ref": "AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -8107,6 +8175,10 @@ "$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." }, +"vertexAi": { +"$ref": "VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -9210,6 +9282,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -10228,6 +10345,25 @@ }, "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 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" +}, "GoogleCloudSecuritycenterV2Denied": { "description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", @@ -10500,6 +10636,10 @@ "$ref": "GoogleCloudSecuritycenterV2AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "GoogleCloudSecuritycenterV2AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -10749,7 +10889,7 @@ "type": "string" }, "name": { -"description": "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}`", +"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": { @@ -10847,6 +10987,10 @@ "$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." }, +"vertexAi": { +"$ref": "GoogleCloudSecuritycenterV2VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -11749,7 +11893,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -11769,6 +11915,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -11885,7 +12032,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -11905,6 +12054,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -12066,7 +12216,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -12086,6 +12238,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -12202,7 +12355,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -12222,6 +12377,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -12497,6 +12653,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Pod": { "description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", @@ -13198,6 +13369,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", @@ -14248,7 +14440,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -14268,6 +14462,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -14384,7 +14579,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -14404,6 +14601,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -14565,7 +14763,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -14585,6 +14785,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -14701,7 +14902,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -14721,6 +14924,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -15023,6 +15227,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "Pod": { "description": "A Kubernetes Pod.", "id": "Pod", @@ -16071,6 +16290,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 43e84228ed..31c5154e91 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20250519", +"revision": "20250609", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1029,6 +1029,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -2109,6 +2154,25 @@ }, "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 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", @@ -2352,6 +2416,10 @@ "$ref": "AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -2696,6 +2764,10 @@ "$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." }, +"vertexAi": { +"$ref": "VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -3880,6 +3952,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -4898,6 +5015,25 @@ }, "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 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" +}, "GoogleCloudSecuritycenterV2Denied": { "description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", @@ -5170,6 +5306,10 @@ "$ref": "GoogleCloudSecuritycenterV2AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "GoogleCloudSecuritycenterV2AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -5419,7 +5559,7 @@ "type": "string" }, "name": { -"description": "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}`", +"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": { @@ -5517,6 +5657,10 @@ "$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." }, +"vertexAi": { +"$ref": "GoogleCloudSecuritycenterV2VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -6419,7 +6563,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -6439,6 +6585,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -6555,7 +6702,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -6575,6 +6724,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -6736,7 +6886,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -6756,6 +6908,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -6872,7 +7025,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -6892,6 +7047,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -7167,6 +7323,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Pod": { "description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", @@ -7868,6 +8039,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", @@ -8637,7 +8829,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -8657,6 +8851,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -8773,7 +8968,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -8793,6 +8990,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -8954,7 +9152,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -8974,6 +9174,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -9090,7 +9291,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -9110,6 +9313,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -9365,6 +9569,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "Pod": { "description": "A Kubernetes Pod.", "id": "Pod", @@ -10056,6 +10275,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 05fb6f040d..95abca2289 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -2003,7 +2003,7 @@ } } }, -"revision": "20250519", +"revision": "20250609", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2119,6 +2119,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "Allowed": { "description": "Allowed IP rule.", "id": "Allowed", @@ -3135,6 +3180,25 @@ }, "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 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", @@ -3449,6 +3513,10 @@ "$ref": "AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "Application", "description": "Represents an application associated with the finding." @@ -3793,6 +3861,10 @@ "$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." }, +"vertexAi": { +"$ref": "VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -4873,6 +4945,51 @@ }, "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", +"GKE" +], +"enumDescriptions": [ +"Unspecified deployment platform.", +"Vertex AI.", +"Google Kubernetes Engine." +], +"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" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Allowed": { "description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", @@ -5891,6 +6008,25 @@ }, "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 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" +}, "GoogleCloudSecuritycenterV2Denied": { "description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", @@ -6163,6 +6299,10 @@ "$ref": "GoogleCloudSecuritycenterV2AffectedResources", "description": "AffectedResources associated with the finding." }, +"aiModel": { +"$ref": "GoogleCloudSecuritycenterV2AiModel", +"description": "The AI model associated with the finding." +}, "application": { "$ref": "GoogleCloudSecuritycenterV2Application", "description": "Represents an application associated with the finding." @@ -6412,7 +6552,7 @@ "type": "string" }, "name": { -"description": "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}`", +"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": { @@ -6510,6 +6650,10 @@ "$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." }, +"vertexAi": { +"$ref": "GoogleCloudSecuritycenterV2VertexAi", +"description": "VertexAi associated with the finding." +}, "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/)" @@ -7412,7 +7556,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -7432,6 +7578,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -7548,7 +7695,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -7568,6 +7717,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -7729,7 +7879,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -7749,6 +7901,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -7865,7 +8018,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -7885,6 +8040,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -8160,6 +8316,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Pod": { "description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", @@ -8861,6 +9032,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Vulnerability": { "description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", @@ -9381,7 +9573,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -9401,6 +9595,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -9517,7 +9712,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -9537,6 +9734,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -9698,7 +9896,9 @@ "EXPLOIT_PUBLIC_FACING_APPLICATION", "SUPPLY_CHAIN_COMPROMISE", "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", +"EXPLOITATION_FOR_CLIENT_EXECUTION", "USER_EXECUTION", +"LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", "DATA_ENCRYPTED_FOR_IMPACT", @@ -9718,6 +9918,7 @@ "KERNEL_MODULES_AND_EXTENSIONS", "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", +"ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID", "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", "CREDENTIALS_IN_FILES", @@ -9834,7 +10035,9 @@ "T1190", "T1195", "T1195.001", +"T1203", "T1204", +"T1222.002", "T1484", "T1485", "T1486", @@ -9854,6 +10057,7 @@ "T1547.006", "T1547.009", "T1548", +"T1548.001", "T1548.003", "T1552", "T1552.001", @@ -10055,6 +10259,21 @@ }, "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 pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", +"type": "string" +} +}, +"type": "object" +}, "Pod": { "description": "A Kubernetes Pod.", "id": "Pod", @@ -10707,6 +10926,27 @@ }, "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" +}, +"type": "array" +} +}, +"type": "object" +}, "VirtualMachineThreatDetectionSettings": { "description": "Resource capturing the settings for the Virtual Machine Threat Detection service.", "id": "VirtualMachineThreatDetectionSettings", diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index d95ba6b398..8cd0a43d4a 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -875,7 +875,7 @@ } } }, -"revision": "20250513", +"revision": "20250603", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -2489,6 +2489,13 @@ "description": "Data about a specific cell.", "id": "CellData", "properties": { +"chipRuns": { +"description": "Optional. Runs of chips applied to subsections of the cell. Properties of a run start at a specific index in the text and continue until the next run. When reading, all chipped and non-chipped runs are included. Non-chipped runs will have an empty chip_run.chip. When writing, only runs with chips are included. Runs containing chips are of length 1 and are represented in the user-entered text by an \u201c@\u201d placeholder symbol. New runs will overwrite any prior runs. Writing a new user_entered_value will erase previous runs.", +"items": { +"$ref": "ChipRun" +}, +"type": "array" +}, "dataSourceFormula": { "$ref": "DataSourceFormula", "description": "Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`.", @@ -2969,6 +2976,37 @@ }, "type": "object" }, +"Chip": { +"description": "The Smart Chip.", +"id": "Chip", +"properties": { +"personProperties": { +"$ref": "PersonProperties", +"description": "Properties of a linked person." +}, +"richLinkProperties": { +"$ref": "RichLinkProperties", +"description": "Properties of a rich link." +} +}, +"type": "object" +}, +"ChipRun": { +"description": "The run of a chip. The chip continues until the start index of the next run.", +"id": "ChipRun", +"properties": { +"chip": { +"$ref": "Chip", +"description": "Optional. The chip of this run." +}, +"startIndex": { +"description": "Required. The zero-based character index where this run starts, in UTF-16 code units.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ClearBasicFilterRequest": { "description": "Clears the basic filter, if any exists on the sheet.", "id": "ClearBasicFilterRequest", @@ -5527,6 +5565,33 @@ }, "type": "object" }, +"PersonProperties": { +"description": "Properties specific to a linked person.", +"id": "PersonProperties", +"properties": { +"displayFormat": { +"description": "Optional. The display format of the person chip. If not set, the default display format is used.", +"enum": [ +"DISPLAY_FORMAT_UNSPECIFIED", +"DEFAULT", +"LAST_NAME_COMMA_FIRST_NAME", +"EMAIL" +], +"enumDescriptions": [ +"Default value, do not use.", +"Default display format.", +"Last name, first name display format.", +"Email display format." +], +"type": "string" +}, +"email": { +"description": "Required. The email address linked to this person. This field is always present.", +"type": "string" +} +}, +"type": "object" +}, "PieChartSpec": { "description": "A pie chart.", "id": "PieChartSpec", @@ -6493,6 +6558,22 @@ }, "type": "object" }, +"RichLinkProperties": { +"description": "Properties of a link to a Google resource (such as a file in Drive, a YouTube video, a Maps address, or a Calendar event). Only Drive files can be written as chips. All other rich link types are read only. URIs cannot exceed 2000 bytes when writing. NOTE: Writing Drive file chips requires at least one of the `drive.file`, `drive.readonly`, or `drive` OAuth scopes.", +"id": "RichLinkProperties", +"properties": { +"mimeType": { +"description": "Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the link, if there's one (for example, when it's a file in Drive).", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Required. The URI to the link. This is always present.", +"type": "string" +} +}, +"type": "object" +}, "RowData": { "description": "Data about each cell in a row.", "id": "RowData", diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index eea64e7e0f..b7733854af 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2594,7 +2594,7 @@ } } }, -"revision": "20250526", +"revision": "20250610", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2764,6 +2764,10 @@ "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", +"MYSQL_8_0_43", +"MYSQL_8_0_44", +"MYSQL_8_0_45", +"MYSQL_8_0_46", "MYSQL_8_4", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", @@ -2832,6 +2836,10 @@ false, false, false, false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -2858,6 +2866,10 @@ false "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", +"The database major version is MySQL 8.0 and the minor version is 43.", +"The database major version is MySQL 8.0 and the minor version is 44.", +"The database major version is MySQL 8.0 and the minor version is 45.", +"The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", @@ -3211,6 +3223,10 @@ false "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", +"MYSQL_8_0_43", +"MYSQL_8_0_44", +"MYSQL_8_0_45", +"MYSQL_8_0_46", "MYSQL_8_4", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", @@ -3279,6 +3295,10 @@ false, false, false, false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -3305,6 +3325,10 @@ false "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", +"The database major version is MySQL 8.0 and the minor version is 43.", +"The database major version is MySQL 8.0 and the minor version is 44.", +"The database major version is MySQL 8.0 and the minor version is 45.", +"The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", @@ -3625,6 +3649,10 @@ false "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", +"MYSQL_8_0_43", +"MYSQL_8_0_44", +"MYSQL_8_0_45", +"MYSQL_8_0_46", "MYSQL_8_4", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", @@ -3693,6 +3721,10 @@ false, false, false, false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -3719,6 +3751,10 @@ false "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", +"The database major version is MySQL 8.0 and the minor version is 43.", +"The database major version is MySQL 8.0 and the minor version is 44.", +"The database major version is MySQL 8.0 and the minor version is 45.", +"The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", @@ -3997,6 +4033,10 @@ false "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", +"MYSQL_8_0_43", +"MYSQL_8_0_44", +"MYSQL_8_0_45", +"MYSQL_8_0_46", "MYSQL_8_4", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", @@ -4065,6 +4105,10 @@ false, false, false, false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4091,6 +4135,10 @@ false "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", +"The database major version is MySQL 8.0 and the minor version is 43.", +"The database major version is MySQL 8.0 and the minor version is 44.", +"The database major version is MySQL 8.0 and the minor version is 45.", +"The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", @@ -4881,6 +4929,10 @@ false "MYSQL_8_0_40", "MYSQL_8_0_41", "MYSQL_8_0_42", +"MYSQL_8_0_43", +"MYSQL_8_0_44", +"MYSQL_8_0_45", +"MYSQL_8_0_46", "MYSQL_8_4", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", @@ -4949,6 +5001,10 @@ false, false, false, false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4975,6 +5031,10 @@ false "The database major version is MySQL 8.0 and the minor version is 40.", "The database major version is MySQL 8.0 and the minor version is 41.", "The database major version is MySQL 8.0 and the minor version is 42.", +"The database major version is MySQL 8.0 and the minor version is 43.", +"The database major version is MySQL 8.0 and the minor version is 44.", +"The database major version is MySQL 8.0 and the minor version is 45.", +"The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", @@ -6080,8 +6140,7 @@ false "MANAGE_BACKUP", "ENHANCED_BACKUP", "REPAIR_READ_POOL", -"CREATE_READ_POOL", -"PRE_CHECK_MAJOR_VERSION_UPGRADE" +"CREATE_READ_POOL" ], "enumDeprecated": [ false, @@ -6135,7 +6194,6 @@ true, false, false, false, -false, false ], "enumDescriptions": [ @@ -6190,8 +6248,7 @@ false "Changes the BackupTier of a Cloud SQL instance.", "Creates a backup for an Enhanced BackupTier Cloud SQL instance.", "Repairs entire read pool or specified read pool nodes in the read pool.", -"Creates a Cloud SQL read pool instance.", -"Pre-checks the major version upgrade operation." +"Creates a Cloud SQL read pool instance." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 864f4cb3c0..12968e8ac1 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -3368,7 +3368,7 @@ } } }, -"revision": "20250410", +"revision": "20250603", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "Announcement": { @@ -4875,7 +4875,8 @@ "NETAPP_CLOUD_VOLUMES", "THIRD_PARTY_SERVICE", "DELL_POWERSCALE", -"GOOGLE_CLOUD_NETAPP_VOLUMES" +"GOOGLE_CLOUD_NETAPP_VOLUMES", +"GOOGLE_CLOUD_FILESTORE_INSTANCES" ], "enumDescriptions": [ "Unspecified", @@ -4885,7 +4886,8 @@ "Peering connection used for connecting to NetApp Cloud Volumes.", "Peering connection used for connecting to third-party services. Most third-party services require manual setup of reverse peering on the VPC network associated with the third-party service.", "Peering connection used for connecting to Dell PowerScale Filers", -"Peering connection used for connecting to Google Cloud NetApp Volumes." +"Peering connection used for connecting to Google Cloud NetApp Volumes.", +"Peering connection used for connecting to Google Cloud Filestore Instances." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 3f915629a4..6c33eae0e5 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1216,7 +1216,7 @@ } } }, -"revision": "20250326", +"revision": "20250604", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1452,6 +1452,17 @@ }, "type": "object" }, +"GatewayConfig": { +"description": "Configuration options for Cluster HTTP Gateway.", +"id": "GatewayConfig", +"properties": { +"http2Enabled": { +"description": "Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false.", +"type": "boolean" +} +}, +"type": "object" +}, "GceConfidentialInstanceConfig": { "description": "A set of Compute Engine Confidential VM instance options.", "id": "GceConfidentialInstanceConfig", @@ -2368,6 +2379,10 @@ "description": "Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, +"gatewayConfig": { +"$ref": "GatewayConfig", +"description": "Optional. Configuration options for Cluster HTTP Gateway." +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 678887ae3b..a6688a6c39 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1142,7 +1142,7 @@ } } }, -"revision": "20250326", +"revision": "20250604", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1378,6 +1378,17 @@ }, "type": "object" }, +"GatewayConfig": { +"description": "Configuration options for Cluster HTTP Gateway.", +"id": "GatewayConfig", +"properties": { +"http2Enabled": { +"description": "Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false.", +"type": "boolean" +} +}, +"type": "object" +}, "GceConfidentialInstanceConfig": { "description": "A set of Compute Engine Confidential VM instance options.", "id": "GceConfidentialInstanceConfig", @@ -2300,6 +2311,10 @@ "description": "Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, +"gatewayConfig": { +"$ref": "GatewayConfig", +"description": "Optional. Configuration options for Cluster HTTP Gateway." +}, "labels": { "additionalProperties": { "type": "string"