+ sites()
+
Returns the sites Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Child Sites for a specified Platform Child Account.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Update a Platform Child Site.
+close()
+ Close httplib2 connections.+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Platform Child Sites for a specified Platform Child Account.
+
+Args:
+ parent: string, Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_publisher_code} (required)
+ pageSize: integer, Optional. The maximum number of children to include in the response, used for paging. If unspecified, at most 10000 platforms will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+ pageToken: string, Optional. A page token, received from a previous `ListPlatformChildren` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPlatformChildren` 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 definition for the list platform child sites rpc.
+ "nextPageToken": "A String", # Continuation token used to page through platforms. To retrieve the next page of the results, set the next request's "page_token" value to this.
+ "platformChildSites": [ # The platform child sites returned in this list response.
+ { # 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}/sites/{platformChildSite}
+ "platformGroup": "A String", # Resource name of the Platform Group of the Platform Child Site.
+ },
+ ],
+}
+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)
+ Update a Platform Child Site.
+
+Args:
+ name: string, Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child}/sites/{platformChildSite} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # 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}/sites/{platformChildSite}
+ "platformGroup": "A String", # Resource name of the Platform Group of the Platform Child Site.
+}
+
+ updateMask: string, Optional. The list of fields to update - currently only supports updating the `platform_group` field.
+ 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}/sites/{platformChildSite}
+ "platformGroup": "A String", # Resource name of the Platform Group of the Platform Child Site.
+}
+
+ close()
Close httplib2 connections.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Groups for a specified Platform.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Platform Groups for a specified Platform.
+
+Args:
+ parent: string, Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform} (required)
+ pageSize: integer, Optional. The maximum number of groups to include in the response, used for paging. If unspecified, at most 10000 groups will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+ pageToken: string, Optional. A page token, received from a previous `ListPlatformGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPlatformGroups` 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 definition for the platform groups list rpc.
+ "nextPageToken": "A String", # Continuation token used to page through platforms. To retrieve the next page of the results, set the next request's "page_token" value to this.
+ "platformGroups": [ # The platform groups returned in this list response.
+ { # 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_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. ++
+ childAccounts()
+
Returns the childAccounts Resource.
+ +
+ groups()
+
Returns the groups Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/aiplatform_v1.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.datasets.datasetVersions.html index 316766865e4..9eccaa63743 100644 --- a/docs/dyn/aiplatform_v1.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1.datasets.datasetVersions.html @@ -120,7 +120,7 @@Updates a DatasetVersion.
Args:
- name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
body: object, The request body.
The object takes the form of:
@@ -287,7 +287,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -309,7 +309,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index c31e1a9ad32..d3eb4ba34c2 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -610,6 +610,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1049,6 +1056,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
index 151de34f676..f47348d9786 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
@@ -189,6 +189,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -400,6 +407,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -636,6 +650,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -858,6 +879,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1088,6 +1116,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1300,6 +1335,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
index 18fe56726e6..6e2596e9943 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -212,7 +212,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -247,7 +247,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -276,7 +276,7 @@ Method Details
Updates a DatasetVersion.
Args:
- name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
body: object, The request body.
The object takes the form of:
@@ -287,7 +287,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -309,7 +309,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 5709759379e..152755654aa 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -1573,6 +1573,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -3442,6 +3449,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
index 7c90ac87d09..58c00140f3c 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
@@ -163,7 +163,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -314,7 +314,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -408,7 +408,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
index 804de669548..ddf2000924d 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
@@ -670,6 +670,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1418,6 +1425,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
index d0df35947b2..843270c9819 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
@@ -131,7 +131,7 @@ Method Details
"name": "A String", # Output only. The resource name of the RagCorpus.
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -245,7 +245,7 @@ Method Details
"name": "A String", # Output only. The resource name of the RagCorpus.
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -300,7 +300,7 @@ Method Details
"name": "A String", # Output only. The resource name of the RagCorpus.
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -361,7 +361,7 @@ Method Details
"name": "A String", # Output only. The resource name of the RagCorpus.
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
diff --git a/docs/dyn/aiplatform_v1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1.projects.locations.schedules.html
index 364815f9314..a57a2801c79 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.schedules.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.schedules.html
@@ -176,7 +176,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -496,7 +496,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -858,7 +858,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1192,7 +1192,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1530,7 +1530,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1851,7 +1851,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
index d8a8efaec42..608986feb92 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
@@ -180,11 +180,14 @@ Method Details
"tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -328,11 +331,14 @@ Method Details
"tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -483,11 +489,14 @@ Method Details
"tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -644,11 +653,14 @@ Method Details
"tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -820,11 +832,14 @@ Method Details
"tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html
index 38a3b058410..4ea517b339d 100644
--- a/docs/dyn/aiplatform_v1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.publishers.models.html
@@ -613,6 +613,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1585,6 +1592,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1beta1.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1beta1.datasets.datasetVersions.html
index 070cfc0e0b4..446aeac430d 100644
--- a/docs/dyn/aiplatform_v1beta1.datasets.datasetVersions.html
+++ b/docs/dyn/aiplatform_v1beta1.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -212,7 +212,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -247,7 +247,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -276,7 +276,7 @@ Method Details
Updates a DatasetVersion.
Args:
- name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
body: object, The request body.
The object takes the form of:
@@ -287,7 +287,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -309,7 +309,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index 34c43f7e366..6ab795ff1f4 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -138,7 +138,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -220,7 +220,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 +336,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -533,7 +533,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -655,7 +655,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -671,6 +671,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -862,7 +869,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1018,7 +1025,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1140,7 +1147,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1156,6 +1163,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1347,7 +1361,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 ef5121c62b1..b2900ae7fbe 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
@@ -144,7 +144,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -191,7 +191,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -207,6 +207,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -389,7 +396,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -436,7 +443,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 +459,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -659,7 +673,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 +720,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -722,6 +736,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -915,7 +936,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -962,7 +983,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -978,6 +999,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1179,7 +1207,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1226,7 +1254,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1242,6 +1270,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1425,7 +1460,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1472,7 +1507,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1488,6 +1523,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
index 6bdc996ea8c..8ec37f6874e 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -212,7 +212,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -247,7 +247,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -276,7 +276,7 @@ Method Details
Updates a DatasetVersion.
Args:
- name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
body: object, The request body.
The object takes the form of:
@@ -287,7 +287,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
@@ -309,7 +309,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index e8580d9f4df..0a802591a7d 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -214,7 +214,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -296,7 +296,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -412,7 +412,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1644,7 +1644,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1766,7 +1766,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1782,6 +1782,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1973,7 +1980,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -3680,7 +3687,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -3802,7 +3809,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -3818,6 +3825,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -4009,7 +4023,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 47e4262a4d8..fb626f8e4ff 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html
@@ -1117,7 +1117,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1172,7 +1172,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 1501b63d7f5..d6291b47d50 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html
@@ -355,7 +355,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -447,7 +447,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -517,7 +517,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -602,7 +602,7 @@ Method Details
},
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
"huggingFaceAccessToken": "A String", # Optional. The Hugging Face read access token used to access the model artifacts of gated models.
- "model": "A String", # Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`
+ "model": "A String", # Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` or Hugging Face model ID like `google/gemma-2-2b-it`.
"modelDisplayName": "A String", # Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html
index 364f2ef4c3f..5ad2591c1e8 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html
@@ -169,7 +169,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -349,7 +349,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -443,7 +443,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
index 0e43bed5313..f6d1d73ed02 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
@@ -159,7 +159,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -241,7 +241,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -357,7 +357,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -596,7 +596,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -718,7 +718,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -734,6 +734,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -925,7 +932,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1425,7 +1432,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1547,7 +1554,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1563,6 +1570,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1754,7 +1768,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
index b2ff60200f5..0b156767d11 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
@@ -151,7 +151,7 @@ Method Details
},
},
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -196,7 +196,7 @@ Method Details
},
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -354,7 +354,7 @@ Method Details
},
},
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -399,7 +399,7 @@ Method Details
},
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -498,7 +498,7 @@ Method Details
},
},
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -543,7 +543,7 @@ Method Details
},
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -648,7 +648,7 @@ Method Details
},
},
"ragVectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The Vector DB config of the RagCorpus.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
@@ -693,7 +693,7 @@ Method Details
},
"updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
"vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
- "apiAuth": { # The generic reusable api auth config. # Authentication config for the chosen Vector DB.
+ "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
"apiKeyConfig": { # The API secret. # The API secret.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
index 492b5bdf41a..a3fa80d4588 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
@@ -492,7 +492,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1187,7 +1187,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -1924,7 +1924,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -2633,7 +2633,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -3346,7 +3346,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -4042,7 +4042,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
- "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "scheduleResourceName": "A String", # The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
index 97c993d1ecf..2eb80a76f49 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
@@ -239,7 +239,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -300,11 +300,14 @@ Method Details
},
},
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -342,7 +345,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -516,7 +519,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -577,11 +580,14 @@ Method Details
},
},
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -619,7 +625,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -800,7 +806,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -861,11 +867,14 @@ Method Details
},
},
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -903,7 +912,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1090,7 +1099,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1151,11 +1160,14 @@ Method Details
},
},
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -1193,7 +1205,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1395,7 +1407,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -1456,11 +1468,14 @@ Method Details
},
},
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+ "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.
+ "A String",
+ ],
"totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
"totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset.
- "totalTruncatedExampleCount": "A String", # The number of examples in the dataset that have been truncated by any amount.
+ "totalTruncatedExampleCount": "A String", # Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
"totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
- "truncatedExampleIndices": [ # A partial sample of the indices (starting from 1) of the truncated examples.
+ "truncatedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
"A String",
],
"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
@@ -1498,7 +1513,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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 1f3a4cce333..8ffbe4ed463 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -147,7 +147,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -229,7 +229,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -345,7 +345,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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,7 +542,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -664,7 +664,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -680,6 +680,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -871,7 +878,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -2133,7 +2140,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -2255,7 +2262,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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.
@@ -2271,6 +2278,13 @@ Method Details
],
"mode": "A String", # Optional. Function calling mode.
},
+ "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
+ "languageCode": "A String", # The language code of the user.
+ "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+ "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+ "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+ },
+ },
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -2462,7 +2476,7 @@ 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, # Optional. Indicates if the part is thought from the model.
+ "thought": True or False, # Output only. Indicates if the part is thought from the model.
"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/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html
index 04e799fb9f4..8f8d6597476 100644
--- a/docs/dyn/analyticsadmin_v1alpha.accounts.html
+++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html
@@ -801,6 +801,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
},
"dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
"androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
@@ -1284,6 +1285,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
},
"dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
"androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html
index 1886aca199f..0394fb82e3e 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.html
@@ -580,6 +580,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
@@ -1109,6 +1110,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
@@ -1124,6 +1126,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html
index 7e68e1414e3..912a64c8375 100644
--- a/docs/dyn/analyticsadmin_v1beta.accounts.html
+++ b/docs/dyn/analyticsadmin_v1beta.accounts.html
@@ -561,6 +561,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
},
"dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
"androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
@@ -643,6 +644,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
},
"dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
"androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.html b/docs/dyn/analyticsadmin_v1beta.properties.html
index 41ab711f533..321c74766d7 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.html
@@ -302,6 +302,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
@@ -615,6 +616,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
@@ -630,6 +632,7 @@ Method Details
"eventDataRetention": "A String", # Required. The length of time that event-level data is retained.
"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
+ "userDataRetention": "A String", # Required. The length of time that user-level data is retained.
}
diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
index ef1dadd86b4..976b8ff259b 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
@@ -138,6 +138,7 @@
+ close()
Close httplib2 connections.
+
+ create(enterpriseId, body=None, x__xgafv=None)
Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
+close()
+ Close httplib2 connections.+
create(enterpriseId, body=None, x__xgafv=None)
+ Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
+
+Args:
+ enterpriseId: string, Required. The ID of the enterprise. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A token used to enroll a device.
+ "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
+ "enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
+ "token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A token used to enroll a device.
+ "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
+ "enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
+ "token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
+}
+
completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)
Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
-
- createEnrollmentToken(enterpriseId, body=None, x__xgafv=None)
Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
createWebToken(enterpriseId, body=None, x__xgafv=None)
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information.
@@ -172,36 +169,6 @@createEnrollmentToken(enterpriseId, body=None, x__xgafv=None)
- Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
-
-Args:
- enterpriseId: string, Required. The ID of the enterprise. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # A token used to enroll a device.
- "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
- "enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
- "token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A token used to enroll a device.
- "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
- "enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
- "token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
-}
-createWebToken(enterpriseId, body=None, x__xgafv=None)
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information. diff --git a/docs/dyn/androidenterprise_v1.html b/docs/dyn/androidenterprise_v1.html index 34511cb93e0..e5eace40873 100644 --- a/docs/dyn/androidenterprise_v1.html +++ b/docs/dyn/androidenterprise_v1.html @@ -79,6 +79,11 @@Instance Methods
Returns the devices Resource.
+ +Returns the enrollmentTokens Resource.
+ diff --git a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.proposals.html b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.proposals.html index 73a839c67ba..b982db2bb2c 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.proposals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.proposals.html @@ -102,7 +102,7 @@Instance Methods
Retrieves the next page of results.
-
patch(name, body=None, updateMask=None, x__xgafv=None)Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.
sendRfp(buyer, body=None, x__xgafv=None)Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
@@ -137,7 +137,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -203,7 +203,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -264,7 +264,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -324,7 +324,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -385,7 +385,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -435,7 +435,7 @@Method Details
@@ -312,7 +312,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)-Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error. +Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable. Args: name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required) @@ -451,7 +451,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -500,7 +500,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -627,7 +627,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html index ab878fd59cf..dde6736f718 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html @@ -102,7 +102,7 @@Instance Methods
Retrieves the next page of results.
-
patch(name, body=None, updateMask=None, x__xgafv=None)Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.
sendRfp(buyer, body=None, x__xgafv=None)Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
@@ -137,7 +137,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -203,7 +203,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -264,7 +264,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -324,7 +324,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -385,7 +385,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -435,7 +435,7 @@Method Details
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index c85012afbbf..43ba7100ea5 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -301,7 +301,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)-Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error. +Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable. Args: name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required) @@ -451,7 +451,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -500,7 +500,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` @@ -627,7 +627,7 @@Method Details
"email": "A String", # Email address for the contact. }, ], - "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). + "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal. # Buyer private data (hidden from seller). "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). }, "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` diff --git a/docs/dyn/classroom_v1.courses.topics.html b/docs/dyn/classroom_v1.courses.topics.html index beb1100017d..90572ed45cb 100644 --- a/docs/dyn/classroom_v1.courses.topics.html +++ b/docs/dyn/classroom_v1.courses.topics.html @@ -79,7 +79,7 @@Instance Methods
Close httplib2 connections.
-
create(courseId, body=None, x__xgafv=None)Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
+Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course does not exist.
delete(courseId, id, x__xgafv=None)Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.
@@ -94,7 +94,7 @@Instance Methods
Retrieves the next page of results.
-
patch(courseId, id, body=None, updateMask=None, x__xgafv=None)Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist
+Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist
Method Details
@@ -394,7 +394,7 @@close()@@ -103,7 +103,7 @@Method Details
@@ -330,7 +330,7 @@create(courseId, body=None, x__xgafv=None)-Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. +Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course does not exist. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) @@ -220,7 +220,7 @@Method Details
@@ -262,7 +262,7 @@patch(courseId, id, body=None, updateMask=None, x__xgafv=None)-Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist +Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index b170d1787da..acfdd62a0d4 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -186,6 +186,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -263,6 +273,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -302,6 +313,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -556,6 +584,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -633,6 +671,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -672,6 +711,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -957,6 +1013,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1034,6 +1100,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1073,6 +1140,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1333,6 +1417,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1410,6 +1504,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1449,6 +1544,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index db839e27767..d4e82c6ddfa 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -185,6 +185,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -262,6 +272,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -301,6 +312,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -555,6 +583,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -632,6 +670,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -671,6 +710,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -956,6 +1012,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1033,6 +1099,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1072,6 +1139,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1332,6 +1416,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1409,6 +1503,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1448,6 +1543,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index e4fdf48c8e9..dbe15b16292 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -174,6 +174,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -251,6 +261,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -290,6 +301,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -713,6 +741,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -790,6 +828,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -829,6 +868,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1280,6 +1336,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1357,6 +1423,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1396,6 +1463,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1831,6 +1915,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1908,6 +2002,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1947,6 +2042,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -2387,6 +2499,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -2464,6 +2586,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -2503,6 +2626,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -2928,6 +3068,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -3005,6 +3155,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -3044,6 +3195,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index eacf55995d6..e47cab3be0a 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -174,6 +174,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -251,6 +261,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -290,6 +301,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -713,6 +741,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -790,6 +828,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -829,6 +868,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1280,6 +1336,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1357,6 +1423,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1396,6 +1463,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -1831,6 +1915,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -1908,6 +2002,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -1947,6 +2042,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -2388,6 +2500,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -2465,6 +2587,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -2504,6 +2627,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. @@ -2927,6 +3067,16 @@Method Details
"state": "A String", # Output only. The state of this build's approval. }, "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + "goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE. + { # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file. + "modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2 + "moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5 + "repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location. + "repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo + "repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project. + "sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage + }, + ], "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. "A String", ], @@ -3004,6 +3154,7 @@Method Details
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup. "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. + "enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". "A String", ], @@ -3043,6 +3194,23 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build. + { # A Go module artifact uploaded to Artifact Registry using the GoModule directive. + "fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact. + "fileHash": [ # Collection of file hashes. + { # Container message for hash values. + "type": "A String", # The type of hash that was performed. + "value": "A String", # The hash value. + }, + ], + }, + "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact. + "endTime": "A String", # End of time span. + "startTime": "A String", # Start of time span. + }, + "uri": "A String", # URI of the uploaded artifact. + }, + ], "images": [ # Container images that were built as a part of the build. { # An image built by the pipeline. "digest": "A String", # Docker Registry 2.0 digest. diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index 03d6f50b22c..8a587aa2bc9 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -118,12 +118,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -393,12 +393,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -541,25 +541,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -572,13 +572,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -605,25 +605,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -636,13 +636,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -799,25 +799,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -830,13 +830,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -892,7 +892,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -910,13 +910,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_alpha.instanceGroups.html b/docs/dyn/compute_alpha.instanceGroups.html index 99cd36993b0..c0dae40584f 100644 --- a/docs/dyn/compute_alpha.instanceGroups.html +++ b/docs/dyn/compute_alpha.instanceGroups.html @@ -287,7 +287,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -501,7 +501,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -534,7 +534,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -697,7 +697,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html index 7d7f61f7176..b703ad2a320 100644 --- a/docs/dyn/compute_alpha.interconnectAttachments.html +++ b/docs/dyn/compute_alpha.interconnectAttachments.html @@ -181,6 +181,28 @@Method Details
"A String", ], "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100. + "a_key": { # Two-level VLAN-to-Appliance mapping rule. + "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used. + "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used. + { # The inner VLAN-to-Appliance mapping. + "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags. + "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100. + "A String", + ], + }, + ], + "name": "A String", # Optional. The name of this appliance mapping rule. + }, + }, + "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped. + "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments. + "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215. + }, + "network": "A String", # Required. Resource URL of the network to which this attachment belongs. + "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment. + }, "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", @@ -445,6 +467,28 @@Method Details
"A String", ], "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100. + "a_key": { # Two-level VLAN-to-Appliance mapping rule. + "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used. + "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used. + { # The inner VLAN-to-Appliance mapping. + "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags. + "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100. + "A String", + ], + }, + ], + "name": "A String", # Optional. The name of this appliance mapping rule. + }, + }, + "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped. + "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments. + "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215. + }, + "network": "A String", # Required. Resource URL of the network to which this attachment belongs. + "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment. + }, "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", @@ -578,6 +622,28 @@Method Details
"A String", ], "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100. + "a_key": { # Two-level VLAN-to-Appliance mapping rule. + "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used. + "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used. + { # The inner VLAN-to-Appliance mapping. + "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags. + "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100. + "A String", + ], + }, + ], + "name": "A String", # Optional. The name of this appliance mapping rule. + }, + }, + "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped. + "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments. + "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215. + }, + "network": "A String", # Required. Resource URL of the network to which this attachment belongs. + "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment. + }, "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", @@ -792,6 +858,28 @@Method Details
"A String", ], "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100. + "a_key": { # Two-level VLAN-to-Appliance mapping rule. + "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used. + "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used. + { # The inner VLAN-to-Appliance mapping. + "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags. + "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100. + "A String", + ], + }, + ], + "name": "A String", # Optional. The name of this appliance mapping rule. + }, + }, + "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped. + "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments. + "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215. + }, + "network": "A String", # Required. Resource URL of the network to which this attachment belongs. + "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment. + }, "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", @@ -905,6 +993,28 @@Method Details
"A String", ], "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. + "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. + "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100. + "a_key": { # Two-level VLAN-to-Appliance mapping rule. + "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used. + "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used. + { # The inner VLAN-to-Appliance mapping. + "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags. + "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100. + "A String", + ], + }, + ], + "name": "A String", # Optional. The name of this appliance mapping rule. + }, + }, + "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped. + "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments. + "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215. + }, + "network": "A String", # Required. Resource URL of the network to which this attachment belongs. + "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment. + }, "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index cf8bc743005..c8edc4aa549 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -141,25 +141,25 @@Method Details
"a_key": { # The name of the scope that contains this set of network endpoint groups. "networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -172,13 +172,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -253,12 +253,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -530,12 +530,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -679,25 +679,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -710,13 +710,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -744,25 +744,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -775,13 +775,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -939,25 +939,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -970,13 +970,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -1023,12 +1023,12 @@Method Details
"endpointFilters": [ # Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported. { "networkEndpoint": { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -1056,7 +1056,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -1074,13 +1074,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_alpha.regionInstanceGroups.html b/docs/dyn/compute_alpha.regionInstanceGroups.html index f042209f8c4..b52afb096d6 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroups.html +++ b/docs/dyn/compute_alpha.regionInstanceGroups.html @@ -127,7 +127,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -173,7 +173,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index cc2e3020b34..edb70d73cfc 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -119,12 +119,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -396,12 +396,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -545,25 +545,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -576,13 +576,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -610,25 +610,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -641,13 +641,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -805,25 +805,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -836,13 +836,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. @@ -899,7 +899,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -917,13 +917,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html index 1593452841a..59c3074df90 100644 --- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html @@ -118,12 +118,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -390,12 +390,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -536,25 +536,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -567,13 +567,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -598,25 +598,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -629,13 +629,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -789,25 +789,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -820,13 +820,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -880,7 +880,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -898,13 +898,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_beta.instanceGroups.html b/docs/dyn/compute_beta.instanceGroups.html index 5c2d2cb8a17..b14964d5fec 100644 --- a/docs/dyn/compute_beta.instanceGroups.html +++ b/docs/dyn/compute_beta.instanceGroups.html @@ -286,7 +286,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -498,7 +498,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -530,7 +530,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -691,7 +691,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html index d94d328224b..178a15f6af0 100644 --- a/docs/dyn/compute_beta.networkEndpointGroups.html +++ b/docs/dyn/compute_beta.networkEndpointGroups.html @@ -141,25 +141,25 @@Method Details
"a_key": { # The name of the scope that contains this set of network endpoint groups. "networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -172,13 +172,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -251,12 +251,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -525,12 +525,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -672,25 +672,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -703,13 +703,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -735,25 +735,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -766,13 +766,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -927,25 +927,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -958,13 +958,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -1009,12 +1009,12 @@Method Details
"endpointFilters": [ # Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported. { "networkEndpoint": { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -1041,7 +1041,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -1059,13 +1059,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_beta.regionInstanceGroups.html b/docs/dyn/compute_beta.regionInstanceGroups.html index cb22c49f202..e5a001c15db 100644 --- a/docs/dyn/compute_beta.regionInstanceGroups.html +++ b/docs/dyn/compute_beta.regionInstanceGroups.html @@ -127,7 +127,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -172,7 +172,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index d7b064245c9..94204fcadf3 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -119,12 +119,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -393,12 +393,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -540,25 +540,25 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -571,13 +571,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -603,25 +603,25 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -634,13 +634,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -795,25 +795,25 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. @@ -826,13 +826,13 @@Method Details
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set. @@ -887,7 +887,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -905,13 +905,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html index f884b876a4f..f7fab92cb39 100644 --- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html @@ -118,12 +118,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -390,12 +390,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -536,38 +536,38 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -586,38 +586,38 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -765,38 +765,38 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -844,7 +844,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -862,13 +862,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_v1.instanceGroups.html b/docs/dyn/compute_v1.instanceGroups.html index 2a0104c1820..6afb26b85cd 100644 --- a/docs/dyn/compute_v1.instanceGroups.html +++ b/docs/dyn/compute_v1.instanceGroups.html @@ -283,7 +283,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -495,7 +495,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -527,7 +527,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -688,7 +688,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index 01fa05fcf53..9f1cd3d9cb4 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -141,38 +141,38 @@Method Details
"a_key": { # The name of the scope that contains this set of network endpoint groups. "networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -239,12 +239,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -513,12 +513,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -660,38 +660,38 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -711,38 +711,38 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -891,38 +891,38 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -978,7 +978,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -996,13 +996,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/compute_v1.regionInstanceGroups.html b/docs/dyn/compute_v1.regionInstanceGroups.html index 1de1c016930..c9253eb6dd2 100644 --- a/docs/dyn/compute_v1.regionInstanceGroups.html +++ b/docs/dyn/compute_v1.regionInstanceGroups.html @@ -124,7 +124,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. @@ -169,7 +169,7 @@Method Details
"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. - "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. + "namedPorts": [ # Optional. Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. { # The named port. For example: <"http", 80>. "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index 9020dc42715..bbd133f1b68 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -119,12 +119,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be attached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -393,12 +393,12 @@Method Details
{ "networkEndpoints": [ # The list of network endpoints to be detached. { # The network endpoint. - "annotations": { # Metadata defined as annotations on the network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. @@ -540,38 +540,38 @@Method Details
An object of the form: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -591,38 +591,38 @@Method Details
The object takes the form of: { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -771,38 +771,38 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointGroup resources. { # Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview. - "annotations": { # Metadata defined as annotations on the network endpoint group. + "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. "a_key": "A String", }, - "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. }, - "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. + "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. # Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "service": "A String", # Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com/<service>. The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. + "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. - "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. + "pscData": { # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. # Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. }, - "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com + "pscTargetService": "A String", # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT. "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "size": 42, # [Output only] Number of network endpoints in the network endpoint group. @@ -851,7 +851,7 @@Method Details
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of NetworkEndpointWithHealthStatus resources. { - "healths": [ # [Output only] The health status of network endpoint; + "healths": [ # [Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured. { "backendService": { # URL of the backend service associated with the health state of the network endpoint. "backendService": "A String", @@ -869,13 +869,13 @@Method Details
"ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health checks configured. }, ], - "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; - "annotations": { # Metadata defined as annotations on the network endpoint. + "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. + "annotations": { # Optional metadata defined as annotations on the network endpoint. "a_key": "A String", }, - "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. - "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. + "instance": "A String", # The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. "ipv6Address": "A String", # Optional IPv6 address of network endpoint. "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP. diff --git a/docs/dyn/config_v1.projects.locations.terraformVersions.html b/docs/dyn/config_v1.projects.locations.terraformVersions.html index bd594969820..b39c4fb73a7 100644 --- a/docs/dyn/config_v1.projects.locations.terraformVersions.html +++ b/docs/dyn/config_v1.projects.locations.terraformVersions.html @@ -123,8 +123,8 @@Method Details
parent: string, Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'. (required) filter: string, Optional. Lists the TerraformVersions that match the filter expression. A filter expression filters the resources 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. orderBy: string, Optional. Field to use to sort the list. - pageSize: integer, Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. - pageToken: string, Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the resources. + pageSize: integer, Optional. When requesting a page of terraform versions, 'page_size' specifies number of terraform versions to return. If unspecified, at most 500 will be returned. The maximum value is 1000. + pageToken: string, Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the terraform versions. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/content_v2_1.conversionsources.html b/docs/dyn/content_v2_1.conversionsources.html index 0713f4470db..e0573e4645c 100644 --- a/docs/dyn/content_v2_1.conversionsources.html +++ b/docs/dyn/content_v2_1.conversionsources.html @@ -119,7 +119,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -133,7 +133,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -162,7 +162,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -176,7 +176,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -227,7 +227,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -241,7 +241,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -282,7 +282,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -296,7 +296,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -345,7 +345,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -359,7 +359,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -389,7 +389,7 @@Method Details
"googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Output only. Attribution settings for the linked Google Analytics property. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. @@ -403,7 +403,7 @@Method Details
"merchantCenterDestination": { # "Merchant Center Destination" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created. # Conversion Source of type "Merchant Center Tag Destination". "attributionSettings": { # Represents attribution settings for conversion sources receiving pre-attribution data. # Required. Attribution settings being used for the Merchant Center Destination. "attributionLookbackWindowInDays": 42, # Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40. - "attributionModel": "A String", # Required. Attribution model. + "attributionModel": "A String", "conversionType": [ # Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time. { # Message representing a types of conversion events "includeInReporting": True or False, # Output only. Option indicating if the type should be included in Merchant Center reporting. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 432dba12212..44de00eca33 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -130,7 +130,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). +{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. @@ -271,12 +271,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. @@ -581,7 +581,7 @@Method Details
Returns: An object of the form: - { # Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). + { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. @@ -722,12 +722,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. @@ -946,7 +946,7 @@Method Details
{ # List dataScans response. "dataScans": [ # DataScans (BASIC view only) under the given parent location. - { # Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). + { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. @@ -1087,12 +1087,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. @@ -1272,7 +1272,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). +{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). "createTime": "A String", # Output only. The time when the scan was created. "data": { # The data source for DataScan. # Required. The data source for DataScan. "entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. @@ -1413,12 +1413,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. @@ -1757,12 +1757,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 1dda71face1..589382df3f3 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -320,12 +320,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. @@ -614,12 +614,12 @@Method Details
"rules": [ # A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true. + "evaluatedCount": "A String", # The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # The number of rows with null values in the specified column. "passRatio": 3.14, # The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. "passed": True or False, # Whether the rule passed or failed. - "passedCount": "A String", # The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. + "passedCount": "A String", # This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index 5555237f7e7..4dc1881b0f1 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -150,7 +150,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. } @@ -203,7 +203,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, ], @@ -465,7 +465,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. } @@ -521,7 +521,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }Method Details
Args: name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required) - orderBy: string, Optional. Specifies the ordering of results. Supported values are: * relevance (default) * last_modified_timestamp * last_modified_timestamp asc + orderBy: string, Optional. Specifies the ordering of results. Supported values are: relevance (default) last_modified_timestamp last_modified_timestamp asc pageSize: integer, Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000. pageToken: string, Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page. query: string, Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax). @@ -369,7 +369,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, "linkedResource": "A String", # Linked resource name. @@ -414,7 +414,7 @@Method Details
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. - "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, }, diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 0a5c4300b73..760bf076d06 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -185,7 +185,7 @@Method Details
"serverAndClientVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. - "clientKey": "A String", # Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. @@ -359,7 +359,7 @@Method Details
"serverAndClientVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. - "clientKey": "A String", # Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. @@ -680,7 +680,7 @@Method Details
"serverAndClientVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. - "clientKey": "A String", # Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. @@ -796,7 +796,7 @@Method Details
"serverAndClientVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. - "clientKey": "A String", # Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. @@ -921,7 +921,7 @@Method Details
"serverAndClientVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. - "clientKey": "A String", # Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html index 5e2bbcdc8c6..a1e59703aa0 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html @@ -129,7 +129,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -148,6 +148,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -211,7 +212,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -230,6 +231,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -361,7 +363,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -380,6 +382,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -503,7 +506,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -522,6 +525,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -603,7 +607,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -622,6 +626,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -686,7 +691,7 @@Method Details
{ # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -705,6 +710,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html index c77624cd9d3..3781fbd2617 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html @@ -189,7 +189,7 @@Method Details
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -208,6 +208,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -349,7 +350,7 @@Method Details
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -368,6 +369,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -534,7 +536,7 @@Method Details
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -553,6 +555,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -706,7 +709,7 @@Method Details
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -725,6 +728,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. @@ -820,7 +824,7 @@Method Details
"playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # The updated playbook. "createTime": "A String", # Output only. The timestamp of initial playbook creation. "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent. - "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. + "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook. "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook. { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment. "description": "A String", # Human-readable description of the parameter. Limited to 300 characters. @@ -839,6 +843,7 @@Method Details
}, ], "instruction": { # Message of the Instruction of the playbook. # Instruction to accomplish target goal. + "guidelines": "A String", # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. "Always be polite". It's valid for this text to be long and used instead of steps altogether. "steps": [ # Ordered list of step by step execution instructions to accomplish target goal. { # Message of single step execution. "steps": [ # Sub-processing needed to execute the current step. 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 fb35072866b..f31a1d8470a 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 @@ -343,6 +343,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). 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 077578b26e3..bd46964bf5e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -343,6 +343,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html index 867917f59d7..c60b2e7a114 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html @@ -109,6 +109,7 @@Method Details
"entities": [ # Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced. "A String", ], + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "healthcareFhirResourceTypes": [ # The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. "A String", ], 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 e3e83f8f1ca..846360c72e2 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 @@ -420,6 +420,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). 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 fce6cb2a7f6..a6a7e2d46a7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1478,6 +1478,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1711,6 +1714,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1998,6 +2002,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2231,6 +2238,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. 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 33549187be6..66087169434 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1478,6 +1478,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1711,6 +1714,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1998,6 +2002,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2231,6 +2238,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index e4c935764b6..11bf60689c9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -177,7 +177,7 @@Method Details
"createTime": "A String", # Output only. Timestamp the Collection was created at. "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -209,7 +209,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -261,7 +261,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. @@ -295,7 +295,7 @@Method Details
{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -327,7 +327,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -379,7 +379,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. @@ -417,7 +417,7 @@Method Details
"createTime": "A String", # Output only. Timestamp the Collection was created at. "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -449,7 +449,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -501,7 +501,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. @@ -549,7 +549,7 @@Method Details
"createTime": "A String", # Output only. Timestamp the Collection was created at. "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -581,7 +581,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -633,7 +633,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. @@ -691,7 +691,7 @@Method Details
{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -723,7 +723,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -775,7 +775,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. @@ -800,7 +800,7 @@Method Details
{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -832,7 +832,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -884,7 +884,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. 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 c20ef40c338..5732210722c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -420,6 +420,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 39fc9ac6194..b6b570dc1ee 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1478,6 +1478,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1711,6 +1714,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1998,6 +2002,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2231,6 +2238,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 91448d56012..a7e21d0fe08 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -449,7 +449,7 @@Method Details
The object takes the form of: { # Request message for CrawlRateManagementService.ObtainCrawlRate method. - "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. + "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. } x__xgafv: string, V1 error format. @@ -816,7 +816,7 @@Method Details
The object takes the form of: { # Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google. - "crawlRateScope": "A String", # Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. + "crawlRateScope": "A String", # Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. } x__xgafv: string, V1 error format. @@ -859,8 +859,8 @@Method Details
{ # Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh. "crawlRate": 42, # Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website. - "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name. - "crawlType": "A String", # Optional. Whether it’s the crawl rate of user-triggered or auto-refresh. + "crawlRateScope": "A String", # Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. + "crawlType": "A String", # Optional. Whether it's the crawl rate of user-triggered or auto-refresh. "mode": "A String", # Optional. Whether the rate is explicitly set by users, or set by vertex AI. } @@ -907,7 +907,7 @@Method Details
"collectionId": "A String", # Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Required. The DataConnector to initialize in the newly created Collection. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. @@ -939,7 +939,7 @@Method Details
"keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, - "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. + "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID. "a_key": "", # Properties of the object. }, }, @@ -991,7 +991,7 @@Method Details
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, - "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. 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 4d78bc99962..aa8bea385f4 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 @@ -343,6 +343,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). 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 02d78dd4211..29142e03212 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1427,6 +1427,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1634,6 +1637,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1918,6 +1922,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2125,6 +2132,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. 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 57f0142d7be..19b21bbadc5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1427,6 +1427,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1634,6 +1637,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1918,6 +1922,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2125,6 +2132,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. 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 a84625ced0c..11b86946674 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -343,6 +343,7 @@Method Details
"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "projectId": "A String", # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. }, + "forceRefreshContent": True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 63751820e80..e86d763ace5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1427,6 +1427,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -1634,6 +1637,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. @@ -1918,6 +1922,9 @@Method Details
"naturalLanguageQueryUnderstandingInfo": { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results. "extractedFilters": "A String", # The filters that were extracted from the input query. "rewrittenQuery": "A String", # Rewritten input query minus the extracted filters. + "sqlRequest": { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase. + "sqlQuery": "A String", # Optional. The SQL query in text format. + }, "structuredExtractedFilter": { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form. "expression": { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. "andExpr": { # Logical `And` operator. # Logical "And" compound operator connecting multiple expressions. @@ -2125,6 +2132,7 @@Method Details
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. "queryId": "A String", # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. }, + "suggestedQuery": "A String", # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). "summary": { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores. "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. diff --git a/docs/dyn/displayvideo_v2.advertisers.campaigns.html b/docs/dyn/displayvideo_v2.advertisers.campaigns.html index 54a83b208f6..0302e741c8e 100644 --- a/docs/dyn/displayvideo_v2.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v2.advertisers.campaigns.html @@ -74,11 +74,6 @@Display & Video 360 API . advertisers . campaigns
Instance Methods
--
-targetingTypes()-Returns the targetingTypes Resource.
-Close httplib2 connections.
@@ -94,12 +89,6 @@Instance Methods
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
- -Lists assigned targeting options of a campaign across targeting types.
--
-listAssignedTargetingOptions_next()Retrieves the next page of results.
Retrieves the next page of results.
@@ -477,346 +466,6 @@Method Details
}
listAssignedTargetingOptions(advertiserId, campaignId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists assigned targeting options of a campaign across targeting types.
-
-Args:
- advertiserId: string, Required. The ID of the advertiser the campaign belongs to. (required)
- campaignId: string, Required. The ID of the campaign to list assigned targeting options for. (required)
- filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
- orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
- pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
- pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
- { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
- "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
- "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
- },
- "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- "displayName": "A String", # Output only. The display name of the app category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- },
- "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
- "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
- "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
- "displayName": "A String", # Output only. The display name of the app.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
- "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
- "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
- "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
- { # Details of first and third party audience targeting setting.
- "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
- "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only.
- "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
- { # Details of combined audience targeting setting.
- "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
- },
- ],
- },
- "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only.
- "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.
- { # Details of custom list targeting setting.
- "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
- },
- ],
- },
- "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored.
- { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
- "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
- { # Details of first and third party audience targeting setting.
- "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
- "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- ],
- "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- },
- "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
- "audioContentType": "A String", # Required. The audio content type.
- },
- "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
- "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
- },
- "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
- "displayName": "A String", # Output only. The display name of the browser.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
- },
- "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
- "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
- },
- "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
- "displayName": "A String", # Output only. The display name of the carrier or ISP.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
- },
- "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
- "displayName": "A String", # Output only. The display name of the category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
- },
- "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
- "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
- "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
- },
- "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- "contentDuration": "A String", # Output only. The content duration.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- },
- "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- "displayName": "A String", # Output only. The display name of the content genre.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- },
- "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
- "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
- },
- "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "contentOutstreamPosition": "A String", # Required. The content outstream position.
- },
- "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- "contentStreamType": "A String", # Output only. The content stream type.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- },
- "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
- "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
- "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
- "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
- "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
- },
- "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- "displayName": "A String", # Output only. The display name of the device make and model.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- },
- "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
- "deviceType": "A String", # Required. The display name of the device type.
- "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
- },
- "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
- "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
- },
- "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
- "environment": "A String", # Required. The serving environment.
- },
- "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
- "exchange": "A String", # Required. The enum value for the exchange.
- },
- "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
- "gender": "A String", # Required. The gender of the audience.
- },
- "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
- "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
- "geoRegionType": "A String", # Output only. The type of geographic region targeting.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
- },
- "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
- "householdIncome": "A String", # Required. The household income of the audience.
- },
- "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
- "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
- "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
- },
- "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
- "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
- },
- "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
- "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
- "displayName": "A String", # Output only. The display name of the language (e.g., "French").
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
- },
- "name": "A String", # Output only. The resource name for this assigned targeting option.
- "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
- "contentPosition": "A String", # Required. The content position.
- },
- "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
- "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
- },
- "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
- "omid": "A String", # Required. The type of Open Measurement enabled inventory.
- },
- "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "onScreenPosition": "A String", # Output only. The on screen position.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- },
- "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- "displayName": "A String", # Output only. The display name of the operating system.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- },
- "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
- "parentalStatus": "A String", # Required. The parental status of the audience.
- },
- "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
- "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
- "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
- "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
- },
- "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
- "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
- "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
- "proximityRadiusUnit": "A String", # Required. Radius distance units.
- },
- "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
- },
- "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
- "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
- },
- "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
- "sessionPosition": "A String", # The position where the ad will show in a session.
- },
- "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
- },
- "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
- "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
- "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
- "excludedAdlooxCategories": [ # Adloox categories to exclude.
- "A String",
- ],
- },
- "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
- "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
- "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
- "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
- },
- "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
- "A String",
- ],
- "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
- "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
- "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
- "A String",
- ],
- "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
- "A String",
- ],
- },
- "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
- "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
- "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
- "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
- },
- "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
- "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
- "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
- },
- "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
- "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
- "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
- "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
- },
- },
- "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
- "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.
- "A String",
- ],
- "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
- "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
- "excludedAdFraudRisk": "A String", # Ad Fraud settings.
- "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
- "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
- "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
- "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
- "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
- "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
- "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
- "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
- "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
- "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
- },
- },
- "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
- },
- "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
- },
- "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
- "videoPlayerSize": "A String", # Required. The video player size.
- },
- "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
- "viewability": "A String", # Required. The predicted viewability percentage.
- },
- "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
- "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
- },
- },
- ],
- "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
-}
-listAssignedTargetingOptions_next()
- Retrieves the next page of results. - - Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - - Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
list_next()
Retrieves the next page of results. diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index 3562b3d9e10..7283fa53344 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -628,7 +628,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -952,7 +952,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1431,7 +1431,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index c87cd5e921d..50fd9ea7720 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -74,11 +74,6 @@Display & Video 360 API . advertisers . insertionOrders
Instance Methods
--
-targetingTypes()-Returns the targetingTypes Resource.
-Close httplib2 connections.
@@ -94,12 +89,6 @@Instance Methods
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
- -Lists assigned targeting options of an insertion order across targeting types.
--
-listAssignedTargetingOptions_next()Retrieves the next page of results.
Retrieves the next page of results.
@@ -529,346 +518,6 @@Method Details
}
listAssignedTargetingOptions(advertiserId, insertionOrderId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists assigned targeting options of an insertion order across targeting types.
-
-Args:
- advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required)
- insertionOrderId: string, Required. The ID of the insertion order to list assigned targeting options for. (required)
- filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
- orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
- pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
- pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
- { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
- "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
- "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
- },
- "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- "displayName": "A String", # Output only. The display name of the app category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- },
- "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
- "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
- "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
- "displayName": "A String", # Output only. The display name of the app.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
- "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
- "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
- "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
- { # Details of first and third party audience targeting setting.
- "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
- "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # The combined audience ids of the included combined audience group. Contains combined audience ids only.
- "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
- { # Details of combined audience targeting setting.
- "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
- },
- ],
- },
- "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # The custom list ids of the included custom list group. Contains custom list ids only.
- "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.
- { # Details of custom list targeting setting.
- "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
- },
- ],
- },
- "includedFirstAndThirdPartyAudienceGroups": [ # The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored.
- { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
- "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.
- { # Details of first and third party audience targeting setting.
- "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
- "recency": "A String", # The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- ],
- "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # The Google audience ids of the included Google audience group. Contains Google audience ids only.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- },
- "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
- "audioContentType": "A String", # Required. The audio content type.
- },
- "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
- "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
- },
- "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
- "displayName": "A String", # Output only. The display name of the browser.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
- },
- "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
- "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
- },
- "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
- "displayName": "A String", # Output only. The display name of the carrier or ISP.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
- },
- "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
- "displayName": "A String", # Output only. The display name of the category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
- },
- "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
- "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
- "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
- },
- "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- "contentDuration": "A String", # Output only. The content duration.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- },
- "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- "displayName": "A String", # Output only. The display name of the content genre.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- },
- "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
- "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
- },
- "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "contentOutstreamPosition": "A String", # Required. The content outstream position.
- },
- "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- "contentStreamType": "A String", # Output only. The content stream type.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- },
- "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
- "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
- "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
- "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
- "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
- },
- "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- "displayName": "A String", # Output only. The display name of the device make and model.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- },
- "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
- "deviceType": "A String", # Required. The display name of the device type.
- "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
- },
- "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
- "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
- },
- "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
- "environment": "A String", # Required. The serving environment.
- },
- "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
- "exchange": "A String", # Required. The enum value for the exchange.
- },
- "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
- "gender": "A String", # Required. The gender of the audience.
- },
- "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
- "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
- "geoRegionType": "A String", # Output only. The type of geographic region targeting.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
- },
- "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
- "householdIncome": "A String", # Required. The household income of the audience.
- },
- "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
- "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
- "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
- },
- "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
- "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
- },
- "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
- "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
- "displayName": "A String", # Output only. The display name of the language (e.g., "French").
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
- },
- "name": "A String", # Output only. The resource name for this assigned targeting option.
- "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
- "contentPosition": "A String", # Required. The content position.
- },
- "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
- "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
- },
- "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
- "omid": "A String", # Required. The type of Open Measurement enabled inventory.
- },
- "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "onScreenPosition": "A String", # Output only. The on screen position.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- },
- "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- "displayName": "A String", # Output only. The display name of the operating system.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- },
- "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
- "parentalStatus": "A String", # Required. The parental status of the audience.
- },
- "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
- "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
- "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
- "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
- },
- "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
- "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
- "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
- "proximityRadiusUnit": "A String", # Required. Radius distance units.
- },
- "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
- },
- "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
- "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
- },
- "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
- "sessionPosition": "A String", # The position where the ad will show in a session.
- },
- "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
- },
- "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
- "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
- "adloox": { # Details of Adloox brand safety settings. # Third party brand verifier -- Adloox.
- "excludedAdlooxCategories": [ # Adloox categories to exclude.
- "A String",
- ],
- },
- "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
- "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
- "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
- "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
- },
- "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
- "A String",
- ],
- "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
- "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
- "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
- "A String",
- ],
- "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
- "A String",
- ],
- },
- "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
- "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
- "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
- "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
- },
- "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
- "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
- "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
- },
- "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
- "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
- "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
- "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
- },
- },
- "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
- "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.
- "A String",
- ],
- "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
- "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
- "excludedAdFraudRisk": "A String", # Ad Fraud settings.
- "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
- "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
- "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
- "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
- "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
- "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
- "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
- "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
- "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
- "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
- },
- },
- "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
- },
- "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
- },
- "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
- "videoPlayerSize": "A String", # Required. The video player size.
- },
- "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
- "viewability": "A String", # Required. The predicted viewability percentage.
- },
- "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
- "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
- },
- },
- ],
- "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
-}
-listAssignedTargetingOptions_next()
- Retrieves the next page of results. - - Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - - Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
list_next()
Retrieves the next page of results. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 8f7b8bb4225..e09ff823cf6 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -391,7 +391,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -759,7 +759,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index ab3980a0914..a542a95c1ad 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -418,7 +418,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -727,7 +727,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1167,7 +1167,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1541,7 +1541,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 3d5511e2da0..9d7b8866863 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -417,7 +417,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -726,7 +726,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1164,7 +1164,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1537,7 +1537,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index 0c34a77e878..16bb21c2ae9 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -380,7 +380,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 10e30e9e6ad..3a67f0b5873 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -418,7 +418,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -792,7 +792,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.html b/docs/dyn/displayvideo_v2.html index 0a341417a7a..74f9e92a6b4 100644 --- a/docs/dyn/displayvideo_v2.html +++ b/docs/dyn/displayvideo_v2.html @@ -94,11 +94,6 @@Instance Methods
Returns the customLists Resource.
--
-firstAndThirdPartyAudiences()-Returns the firstAndThirdPartyAudiences Resource.
- diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html index c2c042c75c7..a0ea2a9ea62 100644 --- a/docs/dyn/displayvideo_v2.partners.html +++ b/docs/dyn/displayvideo_v2.partners.html @@ -377,7 +377,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -701,7 +701,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index be814f7f1cc..a24235c953e 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -417,7 +417,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -726,7 +726,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1164,7 +1164,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1537,7 +1537,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 2a372e81967..894277deb90 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -397,7 +397,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index dec35178e15..13605bdd6e4 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -435,7 +435,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -826,7 +826,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.html index 989fb41ccb2..d75b5fa1951 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.html @@ -774,7 +774,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html index cfa8ce36750..57f64d1f729 100644 --- a/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.campaigns.targetingTypes.assignedTargetingOptions.html @@ -435,7 +435,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -826,7 +826,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index cce937c2b85..a7a75348265 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -640,7 +640,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -981,7 +981,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1477,7 +1477,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index 526e2e364f1..f7a3ea8abcb 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -854,7 +854,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html index 205add852e8..999dbe1e964 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.html @@ -435,7 +435,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -761,7 +761,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1218,7 +1218,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1609,7 +1609,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index 1fde856a88f..61c6a746ed0 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -408,7 +408,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -793,7 +793,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index a64281232f8..2555464b8e5 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -435,7 +435,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -761,7 +761,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1218,7 +1218,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1609,7 +1609,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 81c0dbaa56d..28b036017cc 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -434,7 +434,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -760,7 +760,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1215,7 +1215,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1605,7 +1605,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index 313d8bb37da..862d57dd095 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -394,7 +394,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -735,7 +735,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index c0404c931c2..7aa9924e452 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -434,7 +434,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -760,7 +760,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1215,7 +1215,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). @@ -1605,7 +1605,7 @@Method Details
}, }, "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science. - "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive. "A String", ], "displayViewability": "A String", # Display Viewability section (applicable to display line items only). diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 38aa7f20ffa..15cbcd4193b 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -125,8 +125,8 @@Method Details
The object takes the form of: { # A Filestore instance. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -176,6 +176,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -289,8 +290,8 @@Method Details
An object of the form: { # A Filestore instance. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -340,6 +341,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -394,8 +396,8 @@Method Details
{ # ListInstancesResponse is the result of ListInstancesRequest. "instances": [ # A list of instances 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. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. { # A Filestore instance. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -445,6 +447,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -508,8 +511,8 @@Method Details
The object takes the form of: { # A Filestore instance. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -559,6 +562,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index 73450ea0394..de7954d7a5b 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -132,8 +132,8 @@Method Details
{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -195,6 +195,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -310,8 +311,8 @@Method Details
{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -373,6 +374,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -429,8 +431,8 @@Method Details
{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -492,6 +494,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. @@ -557,8 +560,8 @@Method Details
{ # A Filestore instance. "capacityGb": "A String", # The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to `max_capacity_gb` GB in multipliers of `capacity_step_size_gb` GB. "capacityStepSizeGb": "A String", # Output only. The increase/decrease capacity step size. - "configurablePerformanceEnabled": True or False, # Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. "createTime": "A String", # Output only. The time when the instance was created. + "customPerformanceSupported": True or False, # Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field. "deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). @@ -620,6 +623,7 @@Method Details
}, }, "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. + "maxIops": "A String", # Output only. The max IOPS. "maxReadIops": "A String", # Output only. The max read IOPS. "maxReadThroughputBps": "A String", # Output only. The max read throughput in bytes per second. "maxWriteIops": "A String", # Output only. The max write IOPS. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 26902df25b3..4b3a304fba5 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -126,15 +126,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -142,8 +141,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -327,15 +326,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -343,8 +341,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -628,15 +626,14 @@Method Details
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -644,8 +641,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1086,15 +1083,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1102,8 +1098,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1287,15 +1283,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1303,8 +1298,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1588,15 +1583,14 @@Method Details
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1604,8 +1598,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2034,15 +2028,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2050,8 +2043,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2235,15 +2228,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2251,8 +2243,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2536,15 +2528,14 @@Method Details
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2552,8 +2543,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2937,15 +2928,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2953,8 +2943,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3138,15 +3128,14 @@Method Details
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3154,8 +3143,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3439,15 +3428,14 @@Method Details
"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Output only. Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3455,8 +3443,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 41a9841e736..fa678a30bd5 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -129,15 +129,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -145,8 +144,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -343,15 +342,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -359,8 +357,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -662,15 +660,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -678,8 +675,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1250,15 +1247,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1266,8 +1262,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1464,15 +1460,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1480,8 +1475,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1783,15 +1778,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1799,8 +1793,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2359,15 +2353,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2375,8 +2368,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2573,15 +2566,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2589,8 +2581,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2892,15 +2884,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2908,8 +2899,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3423,15 +3414,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3439,8 +3429,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3637,15 +3627,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3653,8 +3642,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3956,15 +3945,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3972,8 +3960,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index 33af12a5c5f..9501d46e08d 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -129,15 +129,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -145,8 +144,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -342,15 +341,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -358,8 +356,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -652,15 +650,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -668,8 +665,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1125,15 +1122,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1141,8 +1137,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1338,15 +1334,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1354,8 +1349,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1648,15 +1643,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1664,8 +1658,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2109,15 +2103,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2125,8 +2118,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2322,15 +2315,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2338,8 +2330,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2632,15 +2624,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2648,8 +2639,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3048,15 +3039,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3064,8 +3054,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3261,15 +3251,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3277,8 +3266,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -3571,15 +3560,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -3587,8 +3575,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster # Optional. OCI repo configuration for the cluster "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html index 8ec6758b879..d9acc7d73ff 100644 --- a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html @@ -131,15 +131,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -147,8 +146,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -441,15 +440,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -457,8 +455,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -790,15 +788,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -806,8 +803,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1100,15 +1097,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1116,8 +1112,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1389,15 +1385,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1405,8 +1400,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1699,15 +1694,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1715,8 +1709,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1997,15 +1991,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2013,8 +2006,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2307,15 +2300,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2323,8 +2315,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html index 7140428979b..fc7f9aeda4b 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html @@ -131,15 +131,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -147,8 +146,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -441,15 +440,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -457,8 +455,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -790,15 +788,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -806,8 +803,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1100,15 +1097,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1116,8 +1112,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1389,15 +1385,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1405,8 +1400,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1699,15 +1694,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1715,8 +1709,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1997,15 +1991,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2013,8 +2006,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2307,15 +2300,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2323,8 +2315,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html index 1708e942d26..b24efb6a41a 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html @@ -131,15 +131,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -147,8 +146,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -441,15 +440,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -457,8 +455,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -790,15 +788,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -806,8 +803,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1100,15 +1097,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1116,8 +1112,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1389,15 +1385,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1405,8 +1400,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1699,15 +1694,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -1715,8 +1709,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -1997,15 +1991,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2013,8 +2006,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. @@ -2307,15 +2300,14 @@Method Details
}, "cluster": "A String", # Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. "configSync": { # Configuration for Config Sync # Optional. Config Sync configuration for the cluster. - "allowVerticalScale": True or False, # Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated. "enabled": True or False, # Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field. "git": { # Git repo configuration for a single cluster. # Optional. Git repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "httpsProxy": "A String", # Optional. URL for the HTTPS proxy to be used when communicating with the Git repo. "policyDir": "A String", # Optional. The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. - "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. + "secretType": "A String", # Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive. "syncBranch": "A String", # Optional. The branch of the repository to sync from. Default: master. - "syncRepo": "A String", # Optional. The URL of the Git repository to use as the source of truth. + "syncRepo": "A String", # Required. The URL of the Git repository to use as the source of truth. "syncRev": "A String", # Optional. Git revision (tag or hash) to check out. Default HEAD. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, @@ -2323,8 +2315,8 @@Method Details
"oci": { # OCI repo configuration for a single cluster. # Optional. OCI repo configuration for the cluster. "gcpServiceAccountEmail": "A String", # Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. "policyDir": "A String", # Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. - "secretType": "A String", # Optional. Type of secret configured for access to the Git repo. - "syncRepo": "A String", # Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. + "secretType": "A String", # Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive. + "syncRepo": "A String", # Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. "syncWaitSecs": "A String", # Optional. Period in seconds between consecutive syncs. Default: 15. }, "preventDrift": True or False, # Optional. Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index 7872963c41d..983dbea7ab3 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -394,7 +394,7 @@Method Details
], } - profile: string, Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. + profile: string, Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -745,7 +745,7 @@Method Details
The object takes the form of: { # Request to search the resources in the specified FHIR store. - "resourceType": "A String", # Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + "resourceType": "A String", # Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). } x__xgafv: string, V1 error format. @@ -773,12 +773,12 @@Method Details
Args: parent: string, Required. Name of the FHIR store to retrieve resources from. (required) - resourceType: string, Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). (required) + resourceType: string, Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). (required) body: object, The request body. The object takes the form of: { # Request to search the resources in the specified FHIR store. - "resourceType": "A String", # Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + "resourceType": "A String", # Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). } x__xgafv: string, V1 error format. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html index b2c83b883a0..cb139dc2cdf 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html @@ -552,7 +552,7 @@Method Details
], } - profile: string, Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. + profile: string, Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -903,7 +903,7 @@Method Details
The object takes the form of: { # Request to search the resources in the specified FHIR store. - "resourceType": "A String", # Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + "resourceType": "A String", # Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). } x__xgafv: string, V1 error format. @@ -931,12 +931,12 @@Method Details
Args: parent: string, Required. Name of the FHIR store to retrieve resources from. (required) - resourceType: string, Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). (required) + resourceType: string, Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). (required) body: object, The request body. The object takes the form of: { # Request to search the resources in the specified FHIR store. - "resourceType": "A String", # Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + "resourceType": "A String", # Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). } x__xgafv: string, V1 error format. diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html index 133afcc512f..3b17b567ba1 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html @@ -86,6 +86,9 @@Instance Methods
download(name, fileFormat=None, x__xgafv=None)Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.
++
+execute(parent, body=None, x__xgafv=None)Executes all test cases in an integration version.
executeTest(testCaseName, body=None, x__xgafv=None)Executes functional test
@@ -746,6 +749,83 @@Method Details
}
execute(parent, body=None, x__xgafv=None)
+ Executes all test cases in an integration version.
+
+Args:
+ parent: string, Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ExecuteTestCases.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ExecuteTestCases.
+ "executeTestCaseResponses": [ # Results of each execution of test cases in an integration version.
+ { # The response for executing a functional test.
+ "assertionResults": [ # Results of each assertions ran during execution of test case.
+ { # The result of an assertion.
+ "assertion": { # An assertion which will check for a condition over task execution status or an expression for task output variables # Assertion that was run.
+ "assertionStrategy": "A String", # Optional. The type of assertion to perform.
+ "condition": "A String", # Optional. Standard filter expression for ASSERT_CONDITION to succeed
+ "parameter": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4 # Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "masked": True or False, # True if this parameter should be masked in the logs
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "retryCount": 42, # Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION
+ },
+ "failureMessage": "A String", # Details of the assertion failure
+ "status": "A String", # Status of assertion to signify if the assertion succeeded or failed
+ "taskName": "A String", # Task name of task where the assertion was run.
+ "taskNumber": "A String", # Task number of task where the assertion was run.
+ },
+ ],
+ "executionId": "A String", # The id of the execution corresponding to this run of integration.
+ "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "testExecutionState": "A String", # State of the test case execution
+ },
+ ],
+}
+executeTest(testCaseName, body=None, x__xgafv=None)
Executes functional test diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html index d4aaa636c24..a39393c5699 100644 --- a/docs/dyn/logging_v2.entries.html +++ b/docs/dyn/logging_v2.entries.html @@ -107,7 +107,7 @@Method Details
The object takes the form of: { # The parameters to CopyLogEntries. - "destination": "A String", # Required. Destination to which to copy log entries. + "destination": "A String", # Required. Destination to which to copy log entries. For example: "storage.googleapis.com/GCS_BUCKET" "filter": "A String", # Optional. A filter specifying which log entries to copy. The filter must be no more than 20k characters. An empty filter matches all log entries. "name": "A String", # Required. Log bucket from which to copy log entries.For example:"projects/my-project/locations/global/buckets/my-source-bucket" } diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html index 24f524fdbe9..5d5b21332d6 100644 --- a/docs/dyn/looker_v1.projects.locations.instances.html +++ b/docs/dyn/looker_v1.projects.locations.instances.html @@ -141,7 +141,7 @@Method Details
}, "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. - "customDomain": { # Custom domain information. + "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. "state": "A String", # Domain state. }, @@ -372,7 +372,7 @@Method Details
}, "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. - "customDomain": { # Custom domain information. + "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. "state": "A String", # Domain state. }, @@ -587,7 +587,7 @@Method Details
}, "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. - "customDomain": { # Custom domain information. + "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. "state": "A String", # Domain state. }, @@ -723,7 +723,7 @@Method Details
}, "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. - "customDomain": { # Custom domain information. + "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. "state": "A String", # Domain state. }, diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index 750e2181512..8a34c147255 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -198,7 +198,7 @@Method Details
"users": [ # Optional. Users to be added to the account. { # Request message for the `CreateUser` method. "parent": "A String", # Required. The resource name of the account for which a user will be created. Format: `accounts/{account}` - "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Required. The user to create. + "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. The user to create. "accessRights": [ # Optional. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. "A String", ], diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.onlineReturnPolicies.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.onlineReturnPolicies.html index 448d3ea95bd..78088455fd5 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.onlineReturnPolicies.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.onlineReturnPolicies.html @@ -141,6 +141,25 @@Method Details
}, "type": "A String", # Required. Type of return shipping fee. }, + "seasonalOverrides": [ # Optional. Overrides to the general policy for orders placed during a specific set of time intervals. + { # Next: 5 + "begin": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap. + "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. + }, + "end": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. seasonal override end date (inclusive). + "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. + }, + "label": "A String", # Required. Display name of this seasonal override in Merchant Center. + "policy": { # The available policies. # Required. The return policy for the given date range. + "days": "A String", # The number of days items can be returned after delivery, where one day is defined as 24 hours after the delivery timestamp. Required for `NUMBER_OF_DAYS_AFTER_DELIVERY` returns. + "type": "A String", # Policy type. + }, + }, + ], }
Returns the preferenceSets Resource.
+
+ relations()
+
Returns the relations Resource.
+ diff --git a/docs/dyn/migrationcenter_v1.projects.locations.relations.html b/docs/dyn/migrationcenter_v1.projects.locations.relations.html new file mode 100644 index 00000000000..adc81052e35 --- /dev/null +++ b/docs/dyn/migrationcenter_v1.projects.locations.relations.html @@ -0,0 +1,164 @@ + + + +
+ close()
Close httplib2 connections.
+ +Gets the details of an relation.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the relations in a given project and location.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets the details of an relation.
+
+Args:
+ name: string, Required. Name of the resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message representing a relation between 2 resource.
+ "createTime": "A String", # Output only. The timestamp when the relation was created.
+ "dstAsset": "A String", # Output only. The destination asset name in the relation.
+ "name": "A String", # Output only. Identifier. The identifier of the relation.
+ "srcAsset": "A String", # Output only. The source asset name in the relation.
+ "type": "A String", # Optional. The type of the relation.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the relations in a given project and location.
+
+Args:
+ parent: string, Required. Parent value for `ListRelationsRequest`. (required)
+ filter: string, Optional. Filtering results.
+ orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing relations.
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+ "relations": [ # A list of relations.
+ { # Message representing a relation between 2 resource.
+ "createTime": "A String", # Output only. The timestamp when the relation was created.
+ "dstAsset": "A String", # Output only. The destination asset name in the relation.
+ "name": "A String", # Output only. Identifier. The identifier of the relation.
+ "srcAsset": "A String", # Output only. The source asset name in the relation.
+ "type": "A String", # Optional. The type of the relation.
+ },
+ ],
+}
+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. ++
get(name, x__xgafv=None)
Gets a single metric descriptor.
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
list(name, activeOnly=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists metric descriptors that match a filter.
@@ -237,11 +237,12 @@list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(name, activeOnly=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists metric descriptors that match a filter.
Args:
name: string, Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] (required)
+ activeOnly: boolean, Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response. - If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned. - If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.
filter: string, Optional. If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/")
pageSize: integer, Optional. A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.
pageToken: string, Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html
index 370c1ca16bd..a6da30a4c9f 100644
--- a/docs/dyn/netapp_v1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1.projects.locations.volumes.html
@@ -182,6 +182,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -383,6 +384,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -529,6 +531,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -676,6 +679,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
index 600b2e9654e..97b62cc2a29 100644
--- a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
@@ -182,6 +182,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -383,6 +384,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -529,6 +531,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
@@ -676,6 +679,7 @@ Method Details
"export": "A String", # Export string
"exportFull": "A String", # Full export string
"instructions": "A String", # Instructions for mounting
+ "ipAddress": "A String", # Output only. IP Address.
"protocol": "A String", # Protocol to mount with.
},
],
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html
index a412420a31d..0e635820476 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html
@@ -556,7 +556,7 @@ Method Details
"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering.
"A String",
],
- "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.
+ "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.
"A String",
],
"uri": "A String", # Required. The URI of the VPC network resource.
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html
index 2ddaf90f5cb..6cf6a738123 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html
@@ -117,7 +117,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -226,7 +226,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -275,7 +275,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -333,7 +333,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html
index c8ab00284e7..181130ddcd0 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html
@@ -169,7 +169,7 @@ Method Details
"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering.
"A String",
],
- "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.
+ "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.
"A String",
],
"uri": "A String", # Required. The URI of the VPC network resource.
@@ -329,7 +329,7 @@ Method Details
"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering.
"A String",
],
- "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.
+ "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.
"A String",
],
"uri": "A String", # Required. The URI of the VPC network resource.
@@ -478,7 +478,7 @@ Method Details
"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering.
"A String",
],
- "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.
+ "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.
"A String",
],
"uri": "A String", # Required. The URI of the VPC network resource.
@@ -586,7 +586,7 @@ Method Details
"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering.
"A String",
],
- "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.
+ "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.
"A String",
],
"uri": "A String", # Required. The URI of the VPC network resource.
diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html
index f908d00f294..4500d50b1dc 100644
--- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html
+++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html
@@ -127,7 +127,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -237,7 +237,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -335,7 +335,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
@@ -394,7 +394,7 @@ Method Details
"labels": { # User-defined labels.
"a_key": "A String",
},
- "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use.
+ "migration": { # Specification for migration with source and target resource names. # Optional. Must be present if usage is set to FOR_MIGRATION.
"source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}
"target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}
},
diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html
index 3926bc034b8..8cc17f30d5b 100644
--- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html
+++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html
@@ -127,6 +127,7 @@ Method Details
"createTime": "A String", # Output only. The time the test was created.
"description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
"destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -798,6 +799,7 @@ Method Details
},
"roundTrip": True or False, # Whether run analysis for the return path from destination to source. Default value is false.
"source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -910,6 +912,7 @@ Method Details
"createTime": "A String", # Output only. The time the test was created.
"description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
"destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -1581,6 +1584,7 @@ Method Details
},
"roundTrip": True or False, # Whether run analysis for the return path from destination to source. Default value is false.
"source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -1684,6 +1688,7 @@ Method Details
"createTime": "A String", # Output only. The time the test was created.
"description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
"destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -2355,6 +2360,7 @@ Method Details
},
"roundTrip": True or False, # Whether run analysis for the return path from destination to source. Default value is false.
"source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -2417,6 +2423,7 @@ Method Details
"createTime": "A String", # Output only. The time the test was created.
"description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters.
"destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
@@ -3088,6 +3095,7 @@ Method Details
},
"roundTrip": True or False, # Whether run analysis for the return path from destination to source. Default value is false.
"source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.
+ "alloyDbInstance": "A String", # An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.
"appEngineVersion": { # Wrapper for the App Engine service version attributes. # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions).
"uri": "A String", # An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions) name.
},
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html
index 87a45cd583e..08e10e4f1f1 100644
--- a/docs/dyn/redis_v1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1.projects.locations.clusters.html
@@ -163,6 +163,7 @@ Method Details
The object takes the form of:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -417,6 +418,7 @@ Method Details
An object of the form:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -637,6 +639,7 @@ Method Details
{ # Response for ListClusters.
"clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters".
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -840,6 +843,7 @@ Method Details
The object takes the form of:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -1013,7 +1017,7 @@ Method Details
}
requestId: string, Idempotent request UUID.
- updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`
+ updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html
index b703c749f59..24652c8f850 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html
@@ -163,6 +163,7 @@ Method Details
The object takes the form of:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -417,6 +418,7 @@ Method Details
An object of the form:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -637,6 +639,7 @@ Method Details
{ # Response for ListClusters.
"clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters".
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -840,6 +843,7 @@ Method Details
The object takes the form of:
{ # A cluster instance.
+ "asyncClusterEndpointsDeletionEnabled": True or False, # Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
"authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
"automatedBackupConfig": { # The automated backup config for a cluster. # Optional. The automated backup config for the cluster.
"automatedBackupMode": "A String", # Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
@@ -1013,7 +1017,7 @@ Method Details
}
requestId: string, Idempotent request UUID.
- updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`
+ updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/retail_v2.html b/docs/dyn/retail_v2.html
index b0a764a9fc5..16738025aac 100644
--- a/docs/dyn/retail_v2.html
+++ b/docs/dyn/retail_v2.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API
+Vertex AI Search for commerce API
Instance Methods
projects()
diff --git a/docs/dyn/retail_v2.projects.html b/docs/dyn/retail_v2.projects.html
index f522737a5a8..76e65d58636 100644
--- a/docs/dyn/retail_v2.projects.html
+++ b/docs/dyn/retail_v2.projects.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects
+Vertex AI Search for commerce API . projects
Instance Methods
locations()
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html
index 1a1b88e2eeb..1779ccfeaef 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig
+Vertex AI Search for commerce API . projects . locations . catalogs . attributesConfig
Instance Methods
addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.html
index e21189cbf53..864f16edb1e 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches
+Vertex AI Search for commerce API . projects . locations . catalogs . branches
Instance Methods
operations()
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html
index 0127f50c674..e7c9ea87311 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . operations
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html
index 0eefcab6c28..7de8f3c8013 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches . products
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . products
Instance Methods
addFulfillmentPlaces(product, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html
index d4de0ea291c..5d9aef53442 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . completionData
+Vertex AI Search for commerce API . projects . locations . catalogs . completionData
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html
index 9c5496a48c2..1f6a27fcff0 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . controls
+Vertex AI Search for commerce API . projects . locations . catalogs . controls
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestion.html b/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestion.html
index 46a5b5a91f3..0e30bd74822 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestion.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestion.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestion
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestion
Instance Methods
batchUpdate(parent, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestions.html b/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestions.html
index 02840718b70..5eb2c006548 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestions.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.generativeQuestions.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestions
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestions
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.html b/docs/dyn/retail_v2.projects.locations.catalogs.html
index ae7348a02de..b3b9a052660 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs
+Vertex AI Search for commerce API . projects . locations . catalogs
Instance Methods
attributesConfig()
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.models.html b/docs/dyn/retail_v2.projects.locations.catalogs.models.html
index c74e59000b7..1c8360f3700 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.models.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.models.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . models
+Vertex AI Search for commerce API . projects . locations . catalogs . models
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2.projects.locations.catalogs.operations.html
index b1fe8586ce3..77afd9209a3 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.operations.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . operations
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
index c1cdc485c25..4acc476c709 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . placements
+Vertex AI Search for commerce API . projects . locations . catalogs . placements
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
index 59db91978b8..01f72473c8b 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs
+Vertex AI Search for commerce API . projects . locations . catalogs . servingConfigs
Instance Methods
addControl(servingConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
index 3ca12f84e7b..0ec304f4d4b 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . userEvents
+Vertex AI Search for commerce API . projects . locations . catalogs . userEvents
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.locations.html b/docs/dyn/retail_v2.projects.locations.html
index 93aaf64ba8d..aa8c5eb285e 100644
--- a/docs/dyn/retail_v2.projects.locations.html
+++ b/docs/dyn/retail_v2.projects.locations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations
+Vertex AI Search for commerce API . projects . locations
Instance Methods
catalogs()
diff --git a/docs/dyn/retail_v2.projects.locations.operations.html b/docs/dyn/retail_v2.projects.locations.operations.html
index 5e7593179f9..2b1ed732a5a 100644
--- a/docs/dyn/retail_v2.projects.locations.operations.html
+++ b/docs/dyn/retail_v2.projects.locations.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . operations
+Vertex AI Search for commerce API . projects . locations . operations
Instance Methods
diff --git a/docs/dyn/retail_v2.projects.operations.html b/docs/dyn/retail_v2.projects.operations.html
index f4ad4fe4beb..fab651b6291 100644
--- a/docs/dyn/retail_v2.projects.operations.html
+++ b/docs/dyn/retail_v2.projects.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . operations
+Vertex AI Search for commerce API . projects . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.html b/docs/dyn/retail_v2alpha.html
index abfc06583b4..f527223d550 100644
--- a/docs/dyn/retail_v2alpha.html
+++ b/docs/dyn/retail_v2alpha.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API
+Vertex AI Search for commerce API
Instance Methods
projects()
diff --git a/docs/dyn/retail_v2alpha.projects.html b/docs/dyn/retail_v2alpha.projects.html
index e0434ddedf0..b049f4f4feb 100644
--- a/docs/dyn/retail_v2alpha.projects.html
+++ b/docs/dyn/retail_v2alpha.projects.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects
+Vertex AI Search for commerce API . projects
Instance Methods
locations()
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html
index 301d28a79c2..e66e81efb3f 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig
+Vertex AI Search for commerce API . projects . locations . catalogs . attributesConfig
Instance Methods
addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html
index 9fabbc2e88e..0622b622028 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches
+Vertex AI Search for commerce API . projects . locations . catalogs . branches
Instance Methods
operations()
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html
index 733a43b6add..3a87b9ce124 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html
index 0bf39abe85a..d494844f4b0 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches . places
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . places
Instance Methods
operations()
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html
index ba3aa6c2ca1..e85a9d8a3fd 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . branches . places . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . places . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html
index 6f5c0ddec7a..34ec053ea6c 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches . products
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . products
Instance Methods
addFulfillmentPlaces(product, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html
index 4dc5e7a7b9c..d3bda75b88e 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . completionData
+Vertex AI Search for commerce API . projects . locations . catalogs . completionData
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
index 7a7106f9b3a..4d4b70eac26 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . controls
+Vertex AI Search for commerce API . projects . locations . catalogs . controls
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestion.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestion.html
index 61869b4fee4..3d6d3b8d151 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestion.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestion.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestion
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestion
Instance Methods
batchUpdate(parent, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestions.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestions.html
index 71803cf5b7c..80d2f5499cf 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestions.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.generativeQuestions.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestions
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestions
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html
index 81edfac07f0..d61060ba8ee 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs
+Vertex AI Search for commerce API . projects . locations . catalogs
Instance Methods
attributesConfig()
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html
index 2cba0063d8f..964c51fd68e 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . merchantCenterAccountLinks
+Vertex AI Search for commerce API . projects . locations . catalogs . merchantCenterAccountLinks
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
index 3678d808e9c..ac7b151a0c8 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . models
+Vertex AI Search for commerce API . projects . locations . catalogs . models
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html
index ac1cf32ea6a..2dcfc6288e9 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
index cb28ae3474b..30e33a39448 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . placements
+Vertex AI Search for commerce API . projects . locations . catalogs . placements
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
index e0c3a45dd2c..9f575bebb19 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs
+Vertex AI Search for commerce API . projects . locations . catalogs . servingConfigs
Instance Methods
addControl(servingConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
index 5a06524592d..05c0d51f47e 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . userEvents
+Vertex AI Search for commerce API . projects . locations . catalogs . userEvents
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.locations.html b/docs/dyn/retail_v2alpha.projects.locations.html
index 74411644b88..48e90efec0f 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations
+Vertex AI Search for commerce API . projects . locations
Instance Methods
catalogs()
diff --git a/docs/dyn/retail_v2alpha.projects.locations.operations.html b/docs/dyn/retail_v2alpha.projects.locations.operations.html
index 9a108ff68ca..566bc5caa99 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.operations.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . operations
+Vertex AI Search for commerce API . projects . locations . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.operations.html b/docs/dyn/retail_v2alpha.projects.operations.html
index 93861be6a76..b410486d6c9 100644
--- a/docs/dyn/retail_v2alpha.projects.operations.html
+++ b/docs/dyn/retail_v2alpha.projects.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . operations
+Vertex AI Search for commerce API . projects . operations
Instance Methods
diff --git a/docs/dyn/retail_v2alpha.projects.retailProject.html b/docs/dyn/retail_v2alpha.projects.retailProject.html
index d3fef18e4c4..0e004aad6ab 100644
--- a/docs/dyn/retail_v2alpha.projects.retailProject.html
+++ b/docs/dyn/retail_v2alpha.projects.retailProject.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . retailProject
+Vertex AI Search for commerce API . projects . retailProject
Instance Methods
acceptTerms(project, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2beta.html b/docs/dyn/retail_v2beta.html
index 44223fb47be..941644774d4 100644
--- a/docs/dyn/retail_v2beta.html
+++ b/docs/dyn/retail_v2beta.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API
+Vertex AI Search for commerce API
Instance Methods
projects()
diff --git a/docs/dyn/retail_v2beta.projects.html b/docs/dyn/retail_v2beta.projects.html
index 890e93806d7..fb4900fab64 100644
--- a/docs/dyn/retail_v2beta.projects.html
+++ b/docs/dyn/retail_v2beta.projects.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects
+Vertex AI Search for commerce API . projects
Instance Methods
locations()
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html
index ab8e1a355bc..4bddc0f0b57 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig
+Vertex AI Search for commerce API . projects . locations . catalogs . attributesConfig
Instance Methods
addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html
index 6b2e2045723..96f0e08613c 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches
+Vertex AI Search for commerce API . projects . locations . catalogs . branches
Instance Methods
operations()
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html
index 376f35e7761..80fcd037c8c 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . operations
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html
index ad8712daf8f..ef0c3e01ce0 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . branches . products
+Vertex AI Search for commerce API . projects . locations . catalogs . branches . products
Instance Methods
addFulfillmentPlaces(product, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html
index 816e7273d04..e60d02b6d57 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . completionData
+Vertex AI Search for commerce API . projects . locations . catalogs . completionData
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
index d7eb54ba4e9..55f4bb41618 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . controls
+Vertex AI Search for commerce API . projects . locations . catalogs . controls
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestion.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestion.html
index 00a9356560c..9c462cc3478 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestion.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestion.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestion
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestion
Instance Methods
batchUpdate(parent, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestions.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestions.html
index d8b68c6c503..6878ead87d4 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestions.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.generativeQuestions.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestions
+Vertex AI Search for commerce API . projects . locations . catalogs . generativeQuestions
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html
index 390104c1e25..2901787e669 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs
+Vertex AI Search for commerce API . projects . locations . catalogs
Instance Methods
attributesConfig()
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html
index b3aad82e054..d0eef380381 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . catalogs . models
+Vertex AI Search for commerce API . projects . locations . catalogs . models
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html
index 3c86ff147c9..b22cb9ee582 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . operations
+Vertex AI Search for commerce API . projects . locations . catalogs . operations
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
index df9cd7cc902..c8cd66edade 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . placements
+Vertex AI Search for commerce API . projects . locations . catalogs . placements
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
index 393ffc51786..998cee2a5be 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs
+Vertex AI Search for commerce API . projects . locations . catalogs . servingConfigs
Instance Methods
addControl(servingConfig, body=None, x__xgafv=None)
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
index 2cb152a59f3..5363cbc1631 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations . catalogs . userEvents
+Vertex AI Search for commerce API . projects . locations . catalogs . userEvents
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.locations.html b/docs/dyn/retail_v2beta.projects.locations.html
index ef3bc16cefb..41cf4e6ad97 100644
--- a/docs/dyn/retail_v2beta.projects.locations.html
+++ b/docs/dyn/retail_v2beta.projects.locations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . locations
+Vertex AI Search for commerce API . projects . locations
Instance Methods
catalogs()
diff --git a/docs/dyn/retail_v2beta.projects.locations.operations.html b/docs/dyn/retail_v2beta.projects.locations.operations.html
index d9b10e87c8c..bfeb3209d80 100644
--- a/docs/dyn/retail_v2beta.projects.locations.operations.html
+++ b/docs/dyn/retail_v2beta.projects.locations.operations.html
@@ -72,7 +72,7 @@
-
Vertex AI Search for Retail API . projects . locations . operations
+Vertex AI Search for commerce API . projects . locations . operations
Instance Methods
diff --git a/docs/dyn/retail_v2beta.projects.operations.html b/docs/dyn/retail_v2beta.projects.operations.html
index df3f6264abd..4d7c60074ee 100644
--- a/docs/dyn/retail_v2beta.projects.operations.html
+++ b/docs/dyn/retail_v2beta.projects.operations.html
@@ -72,7 +72,7 @@
-Vertex AI Search for Retail API . projects . operations
+Vertex AI Search for commerce API . projects . operations
Instance Methods
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html
index 0644d2ca21c..0126b1a3721 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html
@@ -136,7 +136,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
@@ -169,7 +169,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
@@ -226,7 +226,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
@@ -312,7 +312,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
@@ -363,7 +363,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
@@ -396,7 +396,7 @@ Method Details
"spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered.
"cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
"creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
- "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+ "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
"timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
},
},
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html
index b2d1de41f0a..455b11a2a99 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.html
@@ -94,6 +94,9 @@ Instance Methods
Returns the sessions Resource.
+
+ addSplitPoints(database, body=None, x__xgafv=None)
+Adds split points to specified tables, indexes of a database.
changequorum(name, body=None, x__xgafv=None)
`ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.
@@ -140,6 +143,45 @@ Instance Methods
updateDdl(database, body=None, x__xgafv=None)
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
Method Details
+
+ addSplitPoints(database, body=None, x__xgafv=None)
+ Adds split points to specified tables, indexes of a database.
+
+Args:
+ database: string, Required. The database on whose tables/indexes split points are to be added. Values are of the form `projects//instances//databases/`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for AddSplitPoints.
+ "initiator": "A String", # Optional. A user-supplied tag associated with the split points. For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.
+ "splitPoints": [ # Required. The split points to add.
+ { # The split points of a table/index.
+ "expireTime": "A String", # Optional. The expiration timestamp of the split points. A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified.
+ "index": "A String", # The index to split. If specified, the `table` field must refer to the index's base table.
+ "keys": [ # Required. The list of split keys, i.e., the split boundaries.
+ { # A split key.
+ "keyParts": [ # Required. The column values making up the split key.
+ "",
+ ],
+ },
+ ],
+ "table": "A String", # The table to split.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for AddSplitPoints.
+}
+
+
changequorum(name, body=None, x__xgafv=None)
`ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.
@@ -937,7 +979,7 @@ Method Details
{ # Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.
"operationId": "A String", # If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the `name` of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`.
- "protoDescriptors": "A String", # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobufFileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
+ "protoDescriptors": "A String", # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
"statements": [ # Required. DDL statements to be applied to the database.
"A String",
],
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index d2d1b4f2d21..8ddb03d4131 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -100,10 +100,10 @@ Instance Methods
Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed.
executeSql(session, body=None, x__xgafv=None)
-Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
+Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
executeStreamingSql(session, body=None, x__xgafv=None)
-Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
+Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.
@@ -634,6 +634,7 @@ Method Details
The object takes the form of:
{ # The request for ExecuteBatchDml.
+ "lastStatements": True or False, # Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.
"requestOptions": { # Common request options for various APIs. # Common options for this request.
"priority": "A String", # Priority for the request.
"requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.
@@ -814,7 +815,7 @@ Method Details
executeSql(session, body=None, x__xgafv=None)
- Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
+ Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
Args:
session: string, Required. The session in which the SQL query should be performed. (required)
@@ -842,6 +843,7 @@ Method Details
],
},
},
+ "lastStatement": True or False, # Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.
"paramTypes": { # It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
@@ -1008,7 +1010,7 @@ Method Details
executeStreamingSql(session, body=None, x__xgafv=None)
- Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
+ Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).
Args:
session: string, Required. The session in which the SQL query should be performed. (required)
@@ -1036,6 +1038,7 @@ Method Details
],
},
},
+ "lastStatement": True or False, # Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.
"paramTypes": { # It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
"a_key": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html
index 67ea3726fe1..fc28cbc22eb 100644
--- a/docs/dyn/spanner_v1.projects.instances.html
+++ b/docs/dyn/spanner_v1.projects.instances.html
@@ -189,7 +189,7 @@ Method Details
},
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
"createTime": "A String", # Output only. The time at which the instance was created.
- "defaultBackupScheduleType": "A String", # Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.
+ "defaultBackupScheduleType": "A String", # Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
"edition": "A String", # Optional. The `Edition` of the current instance.
"endpointUris": [ # Deprecated. This field is not populated.
@@ -315,7 +315,7 @@ Method Details
},
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
"createTime": "A String", # Output only. The time at which the instance was created.
- "defaultBackupScheduleType": "A String", # Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.
+ "defaultBackupScheduleType": "A String", # Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
"edition": "A String", # Optional. The `Edition` of the current instance.
"endpointUris": [ # Deprecated. This field is not populated.
@@ -441,7 +441,7 @@ Method Details
},
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
"createTime": "A String", # Output only. The time at which the instance was created.
- "defaultBackupScheduleType": "A String", # Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.
+ "defaultBackupScheduleType": "A String", # Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
"edition": "A String", # Optional. The `Edition` of the current instance.
"endpointUris": [ # Deprecated. This field is not populated.
@@ -577,7 +577,7 @@ Method Details
},
"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
"createTime": "A String", # Output only. The time at which the instance was created.
- "defaultBackupScheduleType": "A String", # Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.
+ "defaultBackupScheduleType": "A String", # Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
"displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
"edition": "A String", # Optional. The `Edition` of the current instance.
"endpointUris": [ # Deprecated. This field is not populated.
diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html
index b2f22cdbfa6..f5f892efaa6 100644
--- a/docs/dyn/texttospeech_v1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1.projects.locations.html
@@ -112,18 +112,18 @@ Method Details
"volumeGainDb": 3.14, # Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
"input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input.
- "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).
- "pronunciations": [ # The pronunciation customizations to be applied.
+ "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.
+ "pronunciations": [ # The pronunciation customizations are applied.
{ # Pronunciation customization for a phrase.
"phoneticEncoding": "A String", # The phonetic encoding of the phrase.
- "phrase": "A String", # The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.
+ "phrase": "A String", # The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.
"pronunciation": "A String", # The pronunciation of the phrase. This must be in the phonetic encoding specified above.
},
],
},
"multiSpeakerMarkup": { # A collection of turns for multi-speaker synthesis. # The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
"turns": [ # Required. Speaker turns.
- { # A Multi-speaker turn.
+ { # A multi-speaker turn.
"speaker": "A String", # Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.
"text": "A String", # Required. The text to speak.
},
@@ -141,7 +141,7 @@ Method Details
"languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
"name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
"ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
- "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.
+ "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
"voiceCloningKey": "A String", # Required. Created by GenerateVoiceCloningKey.
},
},
diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html
index 67533382f97..e520e0ef6b8 100644
--- a/docs/dyn/texttospeech_v1.text.html
+++ b/docs/dyn/texttospeech_v1.text.html
@@ -96,7 +96,7 @@ Method Details
{ # The top-level message sent by the client for the `SynthesizeSpeech` method.
"advancedVoiceOptions": { # Used for advanced voice options. # Advanced voice options.
- "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis will be context aware and have higher latency.
+ "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency.
},
"audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio.
"audioEncoding": "A String", # Required. The format of the audio byte stream.
@@ -109,18 +109,18 @@ Method Details
"volumeGainDb": 3.14, # Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
"input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input.
- "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).
- "pronunciations": [ # The pronunciation customizations to be applied.
+ "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.
+ "pronunciations": [ # The pronunciation customizations are applied.
{ # Pronunciation customization for a phrase.
"phoneticEncoding": "A String", # The phonetic encoding of the phrase.
- "phrase": "A String", # The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.
+ "phrase": "A String", # The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.
"pronunciation": "A String", # The pronunciation of the phrase. This must be in the phonetic encoding specified above.
},
],
},
"multiSpeakerMarkup": { # A collection of turns for multi-speaker synthesis. # The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
"turns": [ # Required. Speaker turns.
- { # A Multi-speaker turn.
+ { # A multi-speaker turn.
"speaker": "A String", # Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.
"text": "A String", # Required. The text to speak.
},
@@ -137,7 +137,7 @@ Method Details
"languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
"name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
"ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
- "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.
+ "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
"voiceCloningKey": "A String", # Required. Created by GenerateVoiceCloningKey.
},
},
diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html
index 95075eedd35..20337644793 100644
--- a/docs/dyn/texttospeech_v1beta1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html
@@ -112,18 +112,18 @@ Method Details
"volumeGainDb": 3.14, # Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
},
"input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input.
- "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).
- "pronunciations": [ # The pronunciation customizations to be applied.
+ "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.
+ "pronunciations": [ # The pronunciation customizations are applied.
{ # Pronunciation customization for a phrase.
"phoneticEncoding": "A String", # The phonetic encoding of the phrase.
- "phrase": "A String", # The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.
+ "phrase": "A String", # The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.
"pronunciation": "A String", # The pronunciation of the phrase. This must be in the phonetic encoding specified above.
},
],
},
"multiSpeakerMarkup": { # A collection of turns for multi-speaker synthesis. # The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
"turns": [ # Required. Speaker turns.
- { # A Multi-speaker turn.
+ { # A multi-speaker turn.
"speaker": "A String", # Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.
"text": "A String", # Required. The text to speak.
},
@@ -141,7 +141,7 @@ Method Details
"languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
"name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
"ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
- "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.
+ "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
"voiceCloningKey": "A String", # Required. Created by GenerateVoiceCloningKey.
},
},
diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html
index 22b5bc9a7ea..4751f88f2a1 100644
--- a/docs/dyn/texttospeech_v1beta1.text.html
+++ b/docs/dyn/texttospeech_v1beta1.text.html
@@ -96,7 +96,7 @@ Method Details
{ # The top-level message sent by the client for the `SynthesizeSpeech` method.
"advancedVoiceOptions": { # Used for advanced voice options. # Advanced voice options.
- "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis will be context aware and have higher latency.
+ "lowLatencyJourneySynthesis": True or False, # Only for Journey voices. If false, the synthesis is context aware and has a higher latency.
},
"audioConfig": { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio.
"audioEncoding": "A String", # Required. The format of the audio byte stream.
@@ -112,18 +112,18 @@ Method Details
"A String",
],
"input": { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. # Required. The Synthesizer requires either plain text or SSML as input.
- "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).
- "pronunciations": [ # The pronunciation customizations to be applied.
+ "customPronunciations": { # A collection of pronunciation customizations. # Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag.
+ "pronunciations": [ # The pronunciation customizations are applied.
{ # Pronunciation customization for a phrase.
"phoneticEncoding": "A String", # The phonetic encoding of the phrase.
- "phrase": "A String", # The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.
+ "phrase": "A String", # The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.
"pronunciation": "A String", # The pronunciation of the phrase. This must be in the phonetic encoding specified above.
},
],
},
"multiSpeakerMarkup": { # A collection of turns for multi-speaker synthesis. # The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis.
"turns": [ # Required. Speaker turns.
- { # A Multi-speaker turn.
+ { # A multi-speaker turn.
"speaker": "A String", # Required. The speaker of the turn, for example, 'O' or 'Q'. Please refer to documentation for available speakers.
"text": "A String", # Required. The text to speak.
},
@@ -140,7 +140,7 @@ Method Details
"languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
"name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
"ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
- "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration.
+ "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
"voiceCloningKey": "A String", # Required. Created by GenerateVoiceCloningKey.
},
},
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
index f6bd0e589ba..c20dd9dc790 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.html
@@ -141,9 +141,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -153,6 +177,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
}
@@ -187,9 +214,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -199,6 +250,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
}
@@ -258,9 +312,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -270,6 +348,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
}
@@ -316,9 +397,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -328,6 +433,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
},
],
@@ -353,7 +461,7 @@ Method Details
Updates a ScanConfig. This method support partial update of a ScanConfig.
Args:
- name: string, The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. (required)
+ name: string, Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. (required)
body: object, The request body.
The object takes the form of:
@@ -380,9 +488,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -392,6 +524,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
}
@@ -427,9 +562,33 @@ Method Details
"displayName": "A String", # Required. The user provided display name of the ScanConfig.
"exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Security Command Center.
"ignoreHttpStatusErrors": True or False, # Whether to keep scanning even if most requests return HTTP error codes.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Output only. Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "startTime": "A String", # Output only. The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ },
"managedScan": True or False, # Whether the scan config is managed by Web Security Scanner, output only.
"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "name": "A String", # Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
"riskLevel": "A String", # The risk level selected for the scan
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
"intervalDurationDays": 42, # Required. The duration of time between executions in days.
@@ -439,6 +598,9 @@ Method Details
"A String",
],
"staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
+ "A String",
+ ],
"userAgent": "A String", # The user agent used during scanning.
}
diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json
index c72f1a9dd05..c6c323c49bf 100644
--- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json
@@ -1295,7 +1295,7 @@
}
}
},
-"revision": "20241216",
+"revision": "20250115",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessContextManagerOperationMetadata": {
@@ -1822,6 +1822,10 @@
"accessLevel": {
"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.",
"type": "string"
+},
+"resource": {
+"description": "A Google Cloud resource that you want to allow to egress the perimeter. These resources can access data outside the perimeter. This field only supports projects. The project format is `projects/{project_number}`. The resource can be in any Google Cloud organization, not just the organization where the perimeter is defined. You can't use `*` in this field to allow all Google Cloud resources.",
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json
index 6a787dfc7a1..7ef6a686462 100644
--- a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json
@@ -175,6 +175,128 @@
"https://www.googleapis.com/auth/adsense.readonly"
]
}
+},
+"resources": {
+"childAccounts": {
+"resources": {
+"sites": {
+"methods": {
+"list": {
+"description": "Lists Platform Child Sites for a specified Platform Child Account.",
+"flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/childAccounts/{childAccountsId}/sites",
+"httpMethod": "GET",
+"id": "adsenseplatform.accounts.platforms.childAccounts.sites.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The maximum number of children to include in the response, used for paging. If unspecified, at most 10000 platforms will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListPlatformChildren` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPlatformChildren` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_publisher_code}",
+"location": "path",
+"pattern": "^accounts/[^/]+/platforms/[^/]+/childAccounts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/sites",
+"response": {
+"$ref": "ListPlatformChildSitesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/adsense",
+"https://www.googleapis.com/auth/adsense.readonly"
+]
+},
+"patch": {
+"description": "Update a Platform Child Site.",
+"flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/childAccounts/{childAccountsId}/sites/{sitesId}",
+"httpMethod": "PATCH",
+"id": "adsenseplatform.accounts.platforms.childAccounts.sites.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child}/sites/{platformChildSite}",
+"location": "path",
+"pattern": "^accounts/[^/]+/platforms/[^/]+/childAccounts/[^/]+/sites/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The list of fields to update - currently only supports updating the `platform_group` field.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"request": {
+"$ref": "PlatformChildSite"
+},
+"response": {
+"$ref": "PlatformChildSite"
+},
+"scopes": [
+"https://www.googleapis.com/auth/adsense"
+]
+}
+}
+}
+}
+},
+"groups": {
+"methods": {
+"list": {
+"description": "Lists Platform Groups for a specified Platform.",
+"flatPath": "v1alpha/accounts/{accountsId}/platforms/{platformsId}/groups",
+"httpMethod": "GET",
+"id": "adsenseplatform.accounts.platforms.groups.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The maximum number of groups to include in the response, used for paging. If unspecified, at most 10000 groups will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListPlatformGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPlatformGroups` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}",
+"location": "path",
+"pattern": "^accounts/[^/]+/platforms/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/groups",
+"response": {
+"$ref": "ListPlatformGroupsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/adsense",
+"https://www.googleapis.com/auth/adsense.readonly"
+]
+}
+}
+}
}
}
}
@@ -517,7 +639,7 @@
}
}
},
-"revision": "20250108",
+"revision": "20250120",
"rootUrl": "https://adsenseplatform.googleapis.com/",
"schemas": {
"Account": {
@@ -630,6 +752,17 @@
"properties": {},
"type": "object"
},
+"Decimal": {
+"description": "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).",
+"id": "Decimal",
+"properties": {
+"value": {
+"description": "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.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
@@ -699,6 +832,42 @@
},
"type": "object"
},
+"ListPlatformChildSitesResponse": {
+"description": "Response definition for the list platform child sites rpc.",
+"id": "ListPlatformChildSitesResponse",
+"properties": {
+"nextPageToken": {
+"description": "Continuation token used to page through platforms. To retrieve the next page of the results, set the next request's \"page_token\" value to this.",
+"type": "string"
+},
+"platformChildSites": {
+"description": "The platform child sites returned in this list response.",
+"items": {
+"$ref": "PlatformChildSite"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"ListPlatformGroupsResponse": {
+"description": "Response definition for the platform groups list rpc.",
+"id": "ListPlatformGroupsResponse",
+"properties": {
+"nextPageToken": {
+"description": "Continuation token used to page through platforms. To retrieve the next page of the results, set the next request's \"page_token\" value to this.",
+"type": "string"
+},
+"platformGroups": {
+"description": "The platform groups returned in this list response.",
+"items": {
+"$ref": "PlatformGroup"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ListPlatformsResponse": {
"description": "Response definition for the platform list rpc.",
"id": "ListPlatformsResponse",
@@ -766,6 +935,46 @@
},
"type": "object"
},
+"PlatformChildSite": {
+"description": "Representation of a Transparent Platform Child Site.",
+"id": "PlatformChildSite",
+"properties": {
+"domain": {
+"description": "Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child}/sites/{platformChildSite}",
+"type": "string"
+},
+"platformGroup": {
+"description": "Resource name of the Platform Group of the Platform Child Site.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"PlatformGroup": {
+"description": "Representation of a Transparent Platform Group.",
+"id": "PlatformGroup",
+"properties": {
+"description": {
+"description": "Output only. Description of the PlatformGroup.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}",
+"type": "string"
+},
+"revshareMillipercent": {
+"$ref": "Decimal",
+"description": "The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%)."
+}
+},
+"type": "object"
+},
"RequestSiteReviewResponse": {
"description": "Response definition for the site request review rpc.",
"id": "RequestSiteReviewResponse",
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
index d227b14d902..a221b67ea34 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
@@ -624,7 +624,7 @@
],
"parameters": {
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"location": "path",
"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
@@ -3093,7 +3093,7 @@
],
"parameters": {
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
@@ -19327,7 +19327,7 @@
}
}
},
-"revision": "20241214",
+"revision": "20250114",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -19644,7 +19644,7 @@
"type": "object"
},
"CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": {
-"description": "Create API error message for Vertex Pipeline. Next Id: 3.",
+"description": "Create API error message for Vertex Pipeline.",
"id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail",
"properties": {
"errorCause": {
@@ -19695,8 +19695,8 @@
"Resolver spec is invalid.",
"Runtime Parameters are invalid.",
"Cloud API not enabled.",
-"Invalid GCS input uri",
-"Invalid GCS output uri",
+"Invalid Cloud Storage input uri",
+"Invalid Cloud Storage output uri",
"Component spec of pipeline is invalid.",
"DagOutputsSpec is invalid.",
"DagSpec is invalid.",
@@ -19923,7 +19923,7 @@
"type": "object"
},
"GoogleCloudAiplatformV1ApiAuth": {
-"description": "The generic reusable api auth config.",
+"description": "The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.",
"id": "GoogleCloudAiplatformV1ApiAuth",
"properties": {
"apiKeyConfig": {
@@ -22752,7 +22752,7 @@
"type": "string"
},
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"readOnly": true,
"type": "string"
},
@@ -31871,8 +31871,7 @@ false
"type": "string"
},
"scheduleResourceName": {
-"description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
-"readOnly": true,
+"description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"type": "string"
},
"serviceAccount": {
@@ -35460,6 +35459,21 @@ false
},
"type": "object"
},
+"GoogleCloudAiplatformV1RetrievalConfig": {
+"description": "Retrieval config.",
+"id": "GoogleCloudAiplatformV1RetrievalConfig",
+"properties": {
+"languageCode": {
+"description": "The language code of the user.",
+"type": "string"
+},
+"latLng": {
+"$ref": "GoogleTypeLatLng",
+"description": "The location of the user."
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1RetrievalMetadata": {
"description": "Metadata related to retrieval in the grounding flow.",
"id": "GoogleCloudAiplatformV1RetrievalMetadata",
@@ -41841,6 +41855,14 @@ false
"description": "Tuning data statistics for Supervised Tuning.",
"id": "GoogleCloudAiplatformV1SupervisedTuningDataStats",
"properties": {
+"droppedExampleReasons": {
+"description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
"totalBillableCharacterCount": {
"deprecated": true,
"description": "Output only. Number of billable characters in the tuning dataset.",
@@ -41855,8 +41877,9 @@ false
"type": "string"
},
"totalTruncatedExampleCount": {
-"description": "The number of examples in the dataset that have been truncated by any amount.",
+"description": "Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"totalTuningCharacterCount": {
@@ -41866,11 +41889,12 @@ false
"type": "string"
},
"truncatedExampleIndices": {
-"description": "A partial sample of the indices (starting from 1) of the truncated examples.",
+"description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.",
"items": {
"format": "int64",
"type": "string"
},
+"readOnly": true,
"type": "array"
},
"tuningDatasetExampleCount": {
@@ -42728,6 +42752,10 @@ false
"functionCallingConfig": {
"$ref": "GoogleCloudAiplatformV1FunctionCallingConfig",
"description": "Optional. Function calling config."
+},
+"retrievalConfig": {
+"$ref": "GoogleCloudAiplatformV1RetrievalConfig",
+"description": "Optional. Retrieval config."
}
},
"type": "object"
@@ -44735,6 +44763,23 @@ false
},
"type": "object"
},
+"GoogleTypeLatLng": {
+"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
+"id": "GoogleTypeLatLng",
+"properties": {
+"latitude": {
+"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+"format": "double",
+"type": "number"
+},
+"longitude": {
+"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
"GoogleTypeMoney": {
"description": "Represents an amount of money with its currency type.",
"id": "GoogleTypeMoney",
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
index a7d6846e892..67fc5cd6ef1 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
@@ -624,7 +624,7 @@
],
"parameters": {
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"location": "path",
"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
@@ -3432,7 +3432,7 @@
],
"parameters": {
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
@@ -21964,7 +21964,7 @@
}
}
},
-"revision": "20241214",
+"revision": "20250114",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -22281,7 +22281,7 @@
"type": "object"
},
"CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": {
-"description": "Create API error message for Vertex Pipeline. Next Id: 3.",
+"description": "Create API error message for Vertex Pipeline.",
"id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail",
"properties": {
"errorCause": {
@@ -22332,8 +22332,8 @@
"Resolver spec is invalid.",
"Runtime Parameters are invalid.",
"Cloud API not enabled.",
-"Invalid GCS input uri",
-"Invalid GCS output uri",
+"Invalid Cloud Storage input uri",
+"Invalid Cloud Storage output uri",
"Component spec of pipeline is invalid.",
"DagOutputsSpec is invalid.",
"DagSpec is invalid.",
@@ -22560,7 +22560,7 @@
"type": "object"
},
"GoogleCloudAiplatformV1beta1ApiAuth": {
-"description": "The generic reusable api auth config.",
+"description": "The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.",
"id": "GoogleCloudAiplatformV1beta1ApiAuth",
"properties": {
"apiKeyConfig": {
@@ -25816,7 +25816,7 @@
"type": "string"
},
"name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"readOnly": true,
"type": "string"
},
@@ -26107,7 +26107,7 @@
"type": "string"
},
"model": {
-"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`",
+"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` or Hugging Face model ID like `google/gemma-2-2b-it`.",
"type": "string"
},
"modelDisplayName": {
@@ -28284,6 +28284,32 @@
"properties": {},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1ExportPublisherModelOperationMetadata": {
+"description": "Runtime operation information for ModelGardenService.ExportPublisherModel.",
+"id": "GoogleCloudAiplatformV1beta1ExportPublisherModelOperationMetadata",
+"properties": {
+"genericMetadata": {
+"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata",
+"description": "The operation generic information."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1ExportPublisherModelResponse": {
+"description": "Response message for ModelGardenService.ExportPublisherModel.",
+"id": "GoogleCloudAiplatformV1beta1ExportPublisherModelResponse",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the model weights.",
+"type": "string"
+},
+"publisherModel": {
+"description": "The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest": {
"description": "Request message for TensorboardService.ExportTensorboardTimeSeriesData.",
"id": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest",
@@ -36644,8 +36670,7 @@ false
"type": "string"
},
"scheduleResourceName": {
-"description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
-"readOnly": true,
+"description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"type": "string"
},
"serviceAccount": {
@@ -37347,7 +37372,8 @@ false
"type": "string"
},
"thought": {
-"description": "Optional. Indicates if the part is thought from the model.",
+"description": "Output only. Indicates if the part is thought from the model.",
+"readOnly": true,
"type": "boolean"
},
"videoMetadata": {
@@ -40891,6 +40917,21 @@ false
},
"type": "object"
},
+"GoogleCloudAiplatformV1beta1RetrievalConfig": {
+"description": "Retrieval config.",
+"id": "GoogleCloudAiplatformV1beta1RetrievalConfig",
+"properties": {
+"languageCode": {
+"description": "The language code of the user.",
+"type": "string"
+},
+"latLng": {
+"$ref": "GoogleTypeLatLng",
+"description": "The location of the user."
+}
+},
+"type": "object"
+},
"GoogleCloudAiplatformV1beta1RetrievalMetadata": {
"description": "Metadata related to retrieval in the grounding flow.",
"id": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
@@ -47633,6 +47674,14 @@ false
"description": "Tuning data statistics for Supervised Tuning.",
"id": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats",
"properties": {
+"droppedExampleReasons": {
+"description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
"totalBillableCharacterCount": {
"deprecated": true,
"description": "Output only. Number of billable characters in the tuning dataset.",
@@ -47647,8 +47696,9 @@ false
"type": "string"
},
"totalTruncatedExampleCount": {
-"description": "The number of examples in the dataset that have been truncated by any amount.",
+"description": "Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"totalTuningCharacterCount": {
@@ -47658,11 +47708,12 @@ false
"type": "string"
},
"truncatedExampleIndices": {
-"description": "A partial sample of the indices (starting from 1) of the truncated examples.",
+"description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.",
"items": {
"format": "int64",
"type": "string"
},
+"readOnly": true,
"type": "array"
},
"tuningDatasetExampleCount": {
@@ -48530,6 +48581,10 @@ false
"functionCallingConfig": {
"$ref": "GoogleCloudAiplatformV1beta1FunctionCallingConfig",
"description": "Optional. Function calling config."
+},
+"retrievalConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1RetrievalConfig",
+"description": "Optional. Retrieval config."
}
},
"type": "object"
@@ -50697,6 +50752,23 @@ false
},
"type": "object"
},
+"GoogleTypeLatLng": {
+"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
+"id": "GoogleTypeLatLng",
+"properties": {
+"latitude": {
+"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+"format": "double",
+"type": "number"
+},
+"longitude": {
+"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
"GoogleTypeMoney": {
"description": "Represents an amount of money with its currency type.",
"id": "GoogleTypeMoney",
diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
index b9f4a4a629d..77bcb9aea2d 100644
--- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
@@ -4886,7 +4886,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250114",
"rootUrl": "https://analyticsadmin.googleapis.com/",
"schemas": {
"GoogleAnalyticsAdminV1alphaAccessBetweenFilter": {
@@ -6845,6 +6845,26 @@
"resetUserDataOnNewActivity": {
"description": "If true, reset the retention period for the user identifier with every event from that user.",
"type": "boolean"
+},
+"userDataRetention": {
+"description": "Required. The length of time that user-level data is retained.",
+"enum": [
+"RETENTION_DURATION_UNSPECIFIED",
+"TWO_MONTHS",
+"FOURTEEN_MONTHS",
+"TWENTY_SIX_MONTHS",
+"THIRTY_EIGHT_MONTHS",
+"FIFTY_MONTHS"
+],
+"enumDescriptions": [
+"Data retention time duration is not specified.",
+"The data retention time duration is 2 months.",
+"The data retention time duration is 14 months.",
+"The data retention time duration is 26 months. Available to 360 properties only. Available for event data only.",
+"The data retention time duration is 38 months. Available to 360 properties only. Available for event data only.",
+"The data retention time duration is 50 months. Available to 360 properties only. Available for event data only."
+],
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json
index b04a3d27d58..a44d69ce3f2 100644
--- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json
@@ -1788,7 +1788,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250114",
"rootUrl": "https://analyticsadmin.googleapis.com/",
"schemas": {
"GoogleAnalyticsAdminV1betaAccessBetweenFilter": {
@@ -2602,6 +2602,26 @@
"resetUserDataOnNewActivity": {
"description": "If true, reset the retention period for the user identifier with every event from that user.",
"type": "boolean"
+},
+"userDataRetention": {
+"description": "Required. The length of time that user-level data is retained.",
+"enum": [
+"RETENTION_DURATION_UNSPECIFIED",
+"TWO_MONTHS",
+"FOURTEEN_MONTHS",
+"TWENTY_SIX_MONTHS",
+"THIRTY_EIGHT_MONTHS",
+"FIFTY_MONTHS"
+],
+"enumDescriptions": [
+"Data retention time duration is not specified.",
+"The data retention time duration is 2 months.",
+"The data retention time duration is 14 months.",
+"The data retention time duration is 26 months. Available to 360 properties only. Available for event data only.",
+"The data retention time duration is 38 months. Available to 360 properties only. Available for event data only.",
+"The data retention time duration is 50 months. Available to 360 properties only. Available for event data only."
+],
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json
index 47e77a6aad7..d1cb3dec479 100644
--- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json
+++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json
@@ -1022,7 +1022,7 @@
}
}
},
-"revision": "20241213",
+"revision": "20250115",
"rootUrl": "https://analyticshub.googleapis.com/",
"schemas": {
"AnalyticsHubSubscriptionInfo": {
@@ -2222,6 +2222,10 @@
"description": "Resource in this dataset that is selectively shared.",
"id": "SelectedResource",
"properties": {
+"routine": {
+"description": "Optional. Format: For routine: `projects/{projectId}/datasets/{datasetId}/routines/{routineId}` Example:\"projects/test_project/datasets/test_dataset/routines/test_routine\"",
+"type": "string"
+},
"table": {
"description": "Optional. Format: For table: `projects/{projectId}/datasets/{datasetId}/tables/{tableId}` Example:\"projects/test_project/datasets/test_dataset/tables/test_table\"",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
index 7a88d4ed5df..b270c4f9916 100644
--- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
+++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
@@ -337,6 +337,37 @@
}
}
},
+"enrollmentTokens": {
+"methods": {
+"create": {
+"description": "Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.",
+"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/enrollmentTokens",
+"httpMethod": "POST",
+"id": "androidenterprise.enrollmentTokens.create",
+"parameterOrder": [
+"enterpriseId"
+],
+"parameters": {
+"enterpriseId": {
+"description": "Required. The ID of the enterprise.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "androidenterprise/v1/enterprises/{enterpriseId}/enrollmentTokens",
+"request": {
+"$ref": "EnrollmentToken"
+},
+"response": {
+"$ref": "EnrollmentToken"
+},
+"scopes": [
+"https://www.googleapis.com/auth/androidenterprise"
+]
+}
+}
+},
"enterprises": {
"methods": {
"acknowledgeNotificationSet": {
@@ -383,33 +414,6 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
-"createEnrollmentToken": {
-"description": "Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.",
-"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
-"httpMethod": "POST",
-"id": "androidenterprise.enterprises.createEnrollmentToken",
-"parameterOrder": [
-"enterpriseId"
-],
-"parameters": {
-"enterpriseId": {
-"description": "Required. The ID of the enterprise.",
-"location": "path",
-"required": true,
-"type": "string"
-}
-},
-"path": "androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentToken",
-"request": {
-"$ref": "EnrollmentToken"
-},
-"response": {
-"$ref": "EnrollmentToken"
-},
-"scopes": [
-"https://www.googleapis.com/auth/androidenterprise"
-]
-},
"createWebToken": {
"description": "Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
@@ -2648,7 +2652,7 @@
}
}
},
-"revision": "20250109",
+"revision": "20250115",
"rootUrl": "https://androidenterprise.googleapis.com/",
"schemas": {
"Administrator": {
diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
index 4b48349c086..cf735cd83af 100644
--- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
+++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
@@ -1102,7 +1102,7 @@
]
},
"patch": {
-"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.",
+"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.",
"flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}",
"httpMethod": "PATCH",
"id": "authorizedbuyersmarketplace.buyers.proposals.patch",
@@ -1367,7 +1367,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250113",
"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
"schemas": {
"AcceptProposalRequest": {
@@ -2626,7 +2626,7 @@
"type": "object"
},
"PrivateData": {
-"description": "Buyers are allowed to store certain types of private data in a proposal or deal.",
+"description": "Buyers are allowed to store certain types of private data in a proposal.",
"id": "PrivateData",
"properties": {
"referenceId": {
diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
index 35e0578363f..40e145caaf5 100644
--- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
@@ -1285,7 +1285,7 @@
]
},
"patch": {
-"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.",
+"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.",
"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}",
"httpMethod": "PATCH",
"id": "authorizedbuyersmarketplace.buyers.proposals.patch",
@@ -1550,7 +1550,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250113",
"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
"schemas": {
"AcceptProposalRequest": {
@@ -2881,7 +2881,7 @@
"type": "object"
},
"PrivateData": {
-"description": "Buyers are allowed to store certain types of private data in a proposal or deal.",
+"description": "Buyers are allowed to store certain types of private data in a proposal.",
"id": "PrivateData",
"properties": {
"referenceId": {
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index 2d8e81a35e2..11b0fb35a0e 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -48,22 +48,22 @@
"description": "View members in Google Chat conversations."
},
"https://www.googleapis.com/auth/chat.messages": {
-"description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages."
+"description": "See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages."
},
"https://www.googleapis.com/auth/chat.messages.create": {
"description": "Compose and send messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions": {
-"description": "See, add, and delete reactions to messages in Google Chat"
+"description": "See, add, and delete reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions.create": {
"description": "Add reactions to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions.readonly": {
-"description": "View reactions to messages in Google Chat"
+"description": "View reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.readonly": {
-"description": "See messages and their associated reactions and attachments in Google Chat"
+"description": "See messages as well as their reactions and message content in Google Chat"
},
"https://www.googleapis.com/auth/chat.spaces": {
"description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat"
@@ -1344,7 +1344,7 @@
}
}
},
-"revision": "20241229",
+"revision": "20250114",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"AccessSettings": {
diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
index 19fc9235ace..811a41807eb 100644
--- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
@@ -1263,7 +1263,7 @@
}
}
},
-"revision": "20241216",
+"revision": "20250111",
"rootUrl": "https://chromemanagement.googleapis.com/",
"schemas": {
"GoogleChromeManagementV1AndroidAppInfo": {
@@ -1762,14 +1762,16 @@ false
"CANARY",
"DEV",
"BETA",
-"STABLE"
+"STABLE",
+"LTS"
],
"enumDescriptions": [
"No release channel specified.",
"Canary release channel.",
"Dev release channel.",
"Beta release channel.",
-"Stable release channel."
+"Stable release channel.",
+"Long-term support release channel."
],
"readOnly": true,
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json
index feb626a5902..53f35bef8a6 100644
--- a/googleapiclient/discovery_cache/documents/classroom.v1.json
+++ b/googleapiclient/discovery_cache/documents/classroom.v1.json
@@ -2,6 +2,12 @@
"auth": {
"oauth2": {
"scopes": {
+"https://www.googleapis.com/auth/classroom.addons.student": {
+"description": "See and update its own attachments to posts in Google Classroom"
+},
+"https://www.googleapis.com/auth/classroom.addons.teacher": {
+"description": "See, create, and update its own attachments to posts in classes you teach in Google Classroom"
+},
"https://www.googleapis.com/auth/classroom.announcements": {
"description": "View and manage announcements in Google Classroom"
},
@@ -590,7 +596,11 @@
"path": "v1/courses/{courseId}/announcements/{itemId}/addOnContext",
"response": {
"$ref": "AddOnContext"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
@@ -769,7 +779,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"delete": {
"description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -810,7 +823,10 @@
"path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "Empty"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"get": {
"description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -851,7 +867,11 @@
"path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -896,7 +916,11 @@
"path": "v1/courses/{courseId}/announcements/{itemId}/addOnAttachments",
"response": {
"$ref": "ListAddOnAttachmentsResponse"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"patch": {
"description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -945,7 +969,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
}
}
@@ -1087,7 +1114,11 @@
"path": "v1/courses/{courseId}/courseWork/{itemId}/addOnContext",
"response": {
"$ref": "AddOnContext"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
@@ -1313,7 +1344,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"delete": {
"description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -1354,7 +1388,10 @@
"path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "Empty"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"get": {
"description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -1395,7 +1432,11 @@
"path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -1440,7 +1481,11 @@
"path": "v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments",
"response": {
"$ref": "ListAddOnAttachmentsResponse"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"patch": {
"description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -1489,7 +1534,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
},
"resources": {
@@ -1543,6 +1591,8 @@
"$ref": "AddOnAttachmentStudentSubmission"
},
"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
]
},
@@ -1601,7 +1651,10 @@
},
"response": {
"$ref": "AddOnAttachmentStudentSubmission"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
}
}
@@ -2301,7 +2354,11 @@
"path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext",
"response": {
"$ref": "AddOnContext"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
@@ -2456,7 +2513,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"delete": {
"description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2497,7 +2557,10 @@
"path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "Empty"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"get": {
"description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2538,7 +2601,11 @@
"path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2583,7 +2650,11 @@
"path": "v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments",
"response": {
"$ref": "ListAddOnAttachmentsResponse"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"patch": {
"description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2632,7 +2703,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
}
}
@@ -2681,7 +2755,11 @@
"path": "v1/courses/{courseId}/posts/{postId}/addOnContext",
"response": {
"$ref": "AddOnContext"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
},
"resources": {
@@ -2726,7 +2804,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"delete": {
"description": "Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2766,7 +2847,10 @@
"path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "Empty"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"get": {
"description": "Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2806,7 +2890,11 @@
"path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}",
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"list": {
"description": "Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2850,7 +2938,11 @@
"path": "v1/courses/{courseId}/posts/{postId}/addOnAttachments",
"response": {
"$ref": "ListAddOnAttachmentsResponse"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
},
"patch": {
"description": "Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.",
@@ -2899,7 +2991,10 @@
},
"response": {
"$ref": "AddOnAttachment"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
},
"resources": {
@@ -2952,6 +3047,8 @@
"$ref": "AddOnAttachmentStudentSubmission"
},
"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.student",
+"https://www.googleapis.com/auth/classroom.addons.teacher",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
]
},
@@ -3009,7 +3106,10 @@
},
"response": {
"$ref": "AddOnAttachmentStudentSubmission"
-}
+},
+"scopes": [
+"https://www.googleapis.com/auth/classroom.addons.teacher"
+]
}
}
}
@@ -3297,7 +3397,7 @@
"topics": {
"methods": {
"create": {
-"description": "Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
+"description": "Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `ALREADY_EXISTS` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course does not exist.",
"flatPath": "v1/courses/{courseId}/topics",
"httpMethod": "POST",
"id": "classroom.courses.topics.create",
@@ -3423,7 +3523,7 @@
]
},
"patch": {
-"description": "Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist",
+"description": "Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if there exists a topic in the course with the same name. * `NOT_FOUND` if the requested course or topic does not exist",
"flatPath": "v1/courses/{courseId}/topics/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.topics.patch",
@@ -3949,7 +4049,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250114",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"AddOnAttachment": {
diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json
index a8f7e3ed60d..d8150ab4245 100644
--- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json
@@ -163,11 +163,6 @@
},
{
"description": "Regional Endpoint",
-"endpointUrl": "https://cloudbuild.northamerica-south1.rep.googleapis.com/",
-"location": "northamerica-south1"
-},
-{
-"description": "Regional Endpoint",
"endpointUrl": "https://cloudbuild.southamerica-east1.rep.googleapis.com/",
"location": "southamerica-east1"
},
@@ -2568,7 +2563,7 @@
}
}
},
-"revision": "20250102",
+"revision": "20250114",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ApprovalConfig": {
@@ -2678,6 +2673,13 @@
"description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps.",
"id": "Artifacts",
"properties": {
+"goModules": {
+"description": "Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.",
+"items": {
+"$ref": "GoModule"
+},
+"type": "array"
+},
"images": {
"description": "A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.",
"items": {
@@ -3258,6 +3260,10 @@
"description": "Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.",
"type": "boolean"
},
+"enableStructuredLogging": {
+"description": "Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.",
+"type": "boolean"
+},
"env": {
"description": "A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\" being given the value \"VALUE\".",
"items": {
@@ -3365,12 +3371,14 @@ false
"NONE",
"SHA256",
"MD5",
+"GO_MODULE_H1",
"SHA512"
],
"enumDescriptions": [
"No hash requested.",
"Use a sha256 hash.",
"Use a md5 hash.",
+"Dirhash of a Go module's source code which is then hex-encoded.",
"Use a sha512 hash."
],
"type": "string"
@@ -4459,6 +4467,37 @@ false
},
"type": "object"
},
+"GoModule": {
+"description": "Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.",
+"id": "GoModule",
+"properties": {
+"modulePath": {
+"description": "Optional. The Go module's \"module path\". e.g. example.com/foo/v2",
+"type": "string"
+},
+"moduleVersion": {
+"description": "Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5",
+"type": "string"
+},
+"repositoryLocation": {
+"description": "Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build\u2019s location.",
+"type": "string"
+},
+"repositoryName": {
+"description": "Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo",
+"type": "string"
+},
+"repositoryProjectId": {
+"description": "Optional. Project ID of the Artifact Registry repository. Defaults to the build project.",
+"type": "string"
+},
+"sourcePath": {
+"description": "Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage",
+"type": "string"
+}
+},
+"type": "object"
+},
"Hash": {
"description": "Container message for hash values.",
"id": "Hash",
@@ -4469,12 +4508,14 @@ false
"NONE",
"SHA256",
"MD5",
+"GO_MODULE_H1",
"SHA512"
],
"enumDescriptions": [
"No hash requested.",
"Use a sha256 hash.",
"Use a md5 hash.",
+"Dirhash of a Go module's source code which is then hex-encoded.",
"Use a sha512 hash."
],
"type": "string"
@@ -5145,6 +5186,13 @@ false
},
"type": "array"
},
+"goModules": {
+"description": "Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.",
+"items": {
+"$ref": "UploadedGoModule"
+},
+"type": "array"
+},
"images": {
"description": "Container images that were built as a part of the build.",
"items": {
@@ -5535,6 +5583,26 @@ false
},
"type": "object"
},
+"UploadedGoModule": {
+"description": "A Go module artifact uploaded to Artifact Registry using the GoModule directive.",
+"id": "UploadedGoModule",
+"properties": {
+"fileHashes": {
+"$ref": "FileHashes",
+"description": "Hash types and values of the Go Module Artifact."
+},
+"pushTiming": {
+"$ref": "TimeSpan",
+"description": "Output only. Stores timing information for pushing the specified artifact.",
+"readOnly": true
+},
+"uri": {
+"description": "URI of the uploaded artifact.",
+"type": "string"
+}
+},
+"type": "object"
+},
"UploadedMavenArtifact": {
"description": "A Maven artifact uploaded using the MavenArtifact directive.",
"id": "UploadedMavenArtifact",
diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json
index 1ca5f58d690..1b278b62593 100644
--- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json
@@ -163,11 +163,6 @@
},
{
"description": "Regional Endpoint",
-"endpointUrl": "https://cloudbuild.northamerica-south1.rep.googleapis.com/",
-"location": "northamerica-south1"
-},
-{
-"description": "Regional Endpoint",
"endpointUrl": "https://cloudbuild.southamerica-east1.rep.googleapis.com/",
"location": "southamerica-east1"
},
@@ -1066,7 +1061,7 @@
}
}
},
-"revision": "20250102",
+"revision": "20250114",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"AuditConfig": {
diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json
index 64497c8cec1..ea1fd975452 100644
--- a/googleapiclient/discovery_cache/documents/compute.alpha.json
+++ b/googleapiclient/discovery_cache/documents/compute.alpha.json
@@ -47599,7 +47599,7 @@
}
}
},
-"revision": "20241231",
+"revision": "20250107",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -63356,7 +63356,7 @@ false
"type": "string"
},
"namedPorts": {
-"description": " Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
+"description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
"items": {
"$ref": "NamedPort"
},
@@ -69051,6 +69051,10 @@ false
"description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
"type": "string"
},
+"l2Forwarding": {
+"$ref": "InterconnectAttachmentL2Forwarding",
+"description": "L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance."
+},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.",
"format": "byte",
@@ -69173,11 +69177,13 @@ false
"description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ",
"enum": [
"DEDICATED",
+"L2_DEDICATED",
"PARTNER",
"PARTNER_PROVIDER"
],
"enumDescriptions": [
"Attachment to a dedicated interconnect.",
+"Attachment to a L2 interconnect, created by the customer.",
"Attachment to a partner interconnect, created by the customer.",
"Attachment to a partner interconnect, created by the partner."
],
@@ -69866,6 +69872,88 @@ false
},
"type": "object"
},
+"InterconnectAttachmentL2Forwarding": {
+"description": "L2 Interconnect Attachment related configuration.",
+"id": "InterconnectAttachmentL2Forwarding",
+"properties": {
+"applianceMappings": {
+"additionalProperties": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMapping"
+},
+"description": "Optional. A map of VLAN tags to appliances and optional inner mapping rules. If VLANs are not explicitly mapped to any appliance, the defaultApplianceIpAddress is used. Each VLAN tag can be a single number or a range of numbers in the range of 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The VLAN tags in the Ethernet header must use an ethertype value of 0x88A8 or 0x8100.",
+"type": "object"
+},
+"defaultApplianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the default destination IP when there is no VLAN mapping result found. Unset field (null-value) indicates the unmatched packet should be dropped.",
+"type": "string"
+},
+"geneveHeader": {
+"$ref": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"description": "Optional. It represents the structure of a Geneve (Generic Network Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization environments."
+},
+"network": {
+"description": "Required. Resource URL of the network to which this attachment belongs.",
+"type": "string"
+},
+"tunnelEndpointIpAddress": {
+"description": "Required. A single IPv4 or IPv6 address. This address will be used as the source IP address for packets sent to the appliances, and must be used as the destination IP address for packets that should be sent out through this attachment.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMapping": {
+"description": "Two-level VLAN-to-Appliance mapping rule.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMapping",
+"properties": {
+"applianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on a VLAN tag, but do not match a more specific inner VLAN tag. Unset field (null-value) indicates both VLAN tags are required to be mapped. Otherwise, defaultApplianceIpAddress is used.",
+"type": "string"
+},
+"innerVlanToApplianceMappings": {
+"description": "Optional. Used to match against the inner VLAN when the packet contains two VLAN tags. A list of mapping rules from inner VLAN tags to IP addresses. If the inner VLAN is not explicitly mapped to an IP address range, the applianceIpAddress is used.",
+"items": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping"
+},
+"type": "array"
+},
+"name": {
+"description": "Optional. The name of this appliance mapping rule.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": {
+"description": "The inner VLAN-to-Appliance mapping.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping",
+"properties": {
+"innerApplianceIpAddress": {
+"description": "Required in this object. A single IPv4 or IPv6 address used as the destination IP address for ingress packets that match on both VLAN tags.",
+"type": "string"
+},
+"innerVlanTags": {
+"description": "Required in this object. Used to match the inner VLAN tag on the packet. Each entry can be a single number or a range of numbers in the range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty and Non-overlapping VLAN tag ranges are enforced, and violating operations will be rejected. The inner VLAN tags must have an ethertype value of 0x8100.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingGeneveHeader": {
+"description": "GeneveHeader related configurations.",
+"id": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"properties": {
+"vni": {
+"description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to 16,777,215.",
+"format": "uint32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"InterconnectAttachmentList": {
"description": "Response to the list request, and contains a list of interconnect attachments.",
"id": "InterconnectAttachmentList",
@@ -75805,11 +75893,11 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint.",
+"description": "Optional metadata defined as annotations on the network endpoint.",
"type": "object"
},
"clientDestinationPort": {
-"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
+"description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
"format": "int32",
"type": "integer"
},
@@ -75818,7 +75906,7 @@ false
"type": "string"
},
"instance": {
-"description": "The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
+"description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
"type": "string"
},
"ipAddress": {
@@ -75849,27 +75937,27 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint group.",
+"description": "Optional. Metadata defined as annotations on the network endpoint group.",
"type": "object"
},
"appEngine": {
"$ref": "NetworkEndpointGroupAppEngine",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudFunction": {
"$ref": "NetworkEndpointGroupCloudFunction",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudRun": {
"$ref": "NetworkEndpointGroupCloudRun",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultPort": {
-"description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
+"description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
"format": "int32",
"type": "integer"
},
@@ -75925,10 +76013,11 @@ false
"type": "string"
},
"pscData": {
-"$ref": "NetworkEndpointGroupPscData"
+"$ref": "NetworkEndpointGroupPscData",
+"description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT."
},
"pscTargetService": {
-"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com",
+"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.",
"type": "string"
},
"region": {
@@ -76785,7 +76874,7 @@ false
"id": "NetworkEndpointWithHealthStatus",
"properties": {
"healths": {
-"description": "[Output only] The health status of network endpoint;",
+"description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.",
"items": {
"$ref": "HealthStatusForNetworkEndpoint"
},
@@ -76793,7 +76882,7 @@ false
},
"networkEndpoint": {
"$ref": "NetworkEndpoint",
-"description": "[Output only] The network endpoint;"
+"description": "[Output only] The network endpoint."
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json
index a0967fd89fc..f63d7e1f817 100644
--- a/googleapiclient/discovery_cache/documents/compute.beta.json
+++ b/googleapiclient/discovery_cache/documents/compute.beta.json
@@ -42856,7 +42856,7 @@
}
}
},
-"revision": "20241231",
+"revision": "20250107",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -56874,7 +56874,7 @@ false
"type": "string"
},
"namedPorts": {
-"description": " Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
+"description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
"items": {
"$ref": "NamedPort"
},
@@ -66904,11 +66904,11 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint.",
+"description": "Optional metadata defined as annotations on the network endpoint.",
"type": "object"
},
"clientDestinationPort": {
-"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
+"description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
"format": "int32",
"type": "integer"
},
@@ -66917,7 +66917,7 @@ false
"type": "string"
},
"instance": {
-"description": "The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
+"description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
"type": "string"
},
"ipAddress": {
@@ -66944,27 +66944,27 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint group.",
+"description": "Optional. Metadata defined as annotations on the network endpoint group.",
"type": "object"
},
"appEngine": {
"$ref": "NetworkEndpointGroupAppEngine",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudFunction": {
"$ref": "NetworkEndpointGroupCloudFunction",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudRun": {
"$ref": "NetworkEndpointGroupCloudRun",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultPort": {
-"description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
+"description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
"format": "int32",
"type": "integer"
},
@@ -67020,10 +67020,11 @@ false
"type": "string"
},
"pscData": {
-"$ref": "NetworkEndpointGroupPscData"
+"$ref": "NetworkEndpointGroupPscData",
+"description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT."
},
"pscTargetService": {
-"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com",
+"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.",
"type": "string"
},
"region": {
@@ -67866,7 +67867,7 @@ false
"id": "NetworkEndpointWithHealthStatus",
"properties": {
"healths": {
-"description": "[Output only] The health status of network endpoint;",
+"description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.",
"items": {
"$ref": "HealthStatusForNetworkEndpoint"
},
@@ -67874,7 +67875,7 @@ false
},
"networkEndpoint": {
"$ref": "NetworkEndpoint",
-"description": "[Output only] The network endpoint;"
+"description": "[Output only] The network endpoint."
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json
index 40ba38038a7..ce51fc43197 100644
--- a/googleapiclient/discovery_cache/documents/compute.v1.json
+++ b/googleapiclient/discovery_cache/documents/compute.v1.json
@@ -38015,7 +38015,7 @@
}
}
},
-"revision": "20241231",
+"revision": "20250107",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -50567,7 +50567,7 @@ false
"type": "string"
},
"namedPorts": {
-"description": " Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
+"description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
"items": {
"$ref": "NamedPort"
},
@@ -60051,11 +60051,11 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint.",
+"description": "Optional metadata defined as annotations on the network endpoint.",
"type": "object"
},
"clientDestinationPort": {
-"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
+"description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.",
"format": "int32",
"type": "integer"
},
@@ -60064,7 +60064,7 @@ false
"type": "string"
},
"instance": {
-"description": "The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
+"description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.",
"type": "string"
},
"ipAddress": {
@@ -60091,27 +60091,27 @@ false
"additionalProperties": {
"type": "string"
},
-"description": "Metadata defined as annotations on the network endpoint group.",
+"description": "Optional. Metadata defined as annotations on the network endpoint group.",
"type": "object"
},
"appEngine": {
"$ref": "NetworkEndpointGroupAppEngine",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudFunction": {
"$ref": "NetworkEndpointGroupCloudFunction",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"cloudRun": {
"$ref": "NetworkEndpointGroupCloudRun",
-"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
+"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultPort": {
-"description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
+"description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.",
"format": "int32",
"type": "integer"
},
@@ -60162,10 +60162,11 @@ false
"type": "string"
},
"pscData": {
-"$ref": "NetworkEndpointGroupPscData"
+"$ref": "NetworkEndpointGroupPscData",
+"description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT."
},
"pscTargetService": {
-"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com",
+"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.",
"type": "string"
},
"region": {
@@ -60937,7 +60938,7 @@ false
"id": "NetworkEndpointWithHealthStatus",
"properties": {
"healths": {
-"description": "[Output only] The health status of network endpoint;",
+"description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.",
"items": {
"$ref": "HealthStatusForNetworkEndpoint"
},
@@ -60945,7 +60946,7 @@ false
},
"networkEndpoint": {
"$ref": "NetworkEndpoint",
-"description": "[Output only] The network endpoint;"
+"description": "[Output only] The network endpoint."
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json
index ca1014c791c..380188dcc4c 100644
--- a/googleapiclient/discovery_cache/documents/config.v1.json
+++ b/googleapiclient/discovery_cache/documents/config.v1.json
@@ -1154,13 +1154,13 @@
"type": "string"
},
"pageSize": {
-"description": "Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.",
+"description": "Optional. When requesting a page of terraform versions, 'page_size' specifies number of terraform versions 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 'ListTerraformVersions' which specifies the position in the list from where to continue listing the resources.",
+"description": "Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the terraform versions.",
"location": "query",
"type": "string"
},
@@ -1187,7 +1187,7 @@
}
}
},
-"revision": "20241211",
+"revision": "20250108",
"rootUrl": "https://config.googleapis.com/",
"schemas": {
"ApplyResults": {
diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json
index e619420a157..2da2ed1d869 100644
--- a/googleapiclient/discovery_cache/documents/content.v2.1.json
+++ b/googleapiclient/discovery_cache/documents/content.v2.1.json
@@ -4570,7 +4570,7 @@
}
}
},
-"revision": "20241217",
+"revision": "20250115",
"rootUrl": "https://shoppingcontent.googleapis.com/",
"schemas": {
"Account": {
@@ -6021,7 +6021,6 @@ false
"type": "integer"
},
"attributionModel": {
-"description": "Required. Attribution model.",
"enum": [
"ATTRIBUTION_MODEL_UNSPECIFIED",
"CROSS_CHANNEL_LAST_CLICK",
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index 6925cc4ef6b..5c6819ded40 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -712,7 +712,7 @@
"type": "string"
},
"orderBy": {
-"description": "Optional. Specifies the ordering of results. Supported values are: * relevance (default) * last_modified_timestamp * last_modified_timestamp asc",
+"description": "Optional. Specifies the ordering of results. Supported values are: relevance (default) last_modified_timestamp last_modified_timestamp asc",
"location": "query",
"type": "string"
},
@@ -6244,7 +6244,7 @@
}
}
},
-"revision": "20241206",
+"revision": "20250116",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
@@ -8085,7 +8085,7 @@
"type": "string"
},
"evaluatedCount": {
-"description": "The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.",
+"description": "The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion.",
"format": "int64",
"type": "string"
},
@@ -8108,7 +8108,7 @@
"type": "boolean"
},
"passedCount": {
-"description": "The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.",
+"description": "This field is not set for rule SqlAssertion.",
"format": "int64",
"type": "string"
},
@@ -8434,7 +8434,7 @@
"type": "object"
},
"GoogleCloudDataplexV1DataScan": {
-"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).",
+"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).",
"id": "GoogleCloudDataplexV1DataScan",
"properties": {
"createTime": {
@@ -9403,7 +9403,7 @@
"type": "string"
},
"parentEntry": {
-"description": "Optional. Immutable. The resource name of the parent entry.",
+"description": "Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.",
"type": "string"
},
"updateTime": {
diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json
index 3a57cc0ac4f..27ff95db1a0 100644
--- a/googleapiclient/discovery_cache/documents/dataportability.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json
@@ -3,199 +3,199 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/dataportability.alerts.subscriptions": {
-"description": "Move a copy of the Google Alerts subscriptions you created."
+"description": "Move a copy of the Google Alerts subscriptions you created"
},
"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": {
-"description": "Move a copy of messages between you and the businesses you have conversations with across Google services."
+"description": "Move a copy of messages between you and the businesses you have conversations with across Google services"
},
"https://www.googleapis.com/auth/dataportability.chrome.autofill": {
-"description": "Move a copy of the information you entered into online forms in Chrome."
+"description": "Move a copy of the information you entered into online forms in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.bookmarks": {
-"description": "Move a copy of pages you bookmarked in Chrome."
+"description": "Move a copy of pages you bookmarked in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.dictionary": {
-"description": "Move a copy of words you added to Chrome's dictionary."
+"description": "Move a copy of words you added to Chrome's dictionary"
},
"https://www.googleapis.com/auth/dataportability.chrome.extensions": {
-"description": "Move a copy of extensions you installed from the Chrome Web Store."
+"description": "Move a copy of extensions you installed from the Chrome Web Store"
},
"https://www.googleapis.com/auth/dataportability.chrome.history": {
-"description": "Move a copy of sites you visited in Chrome."
+"description": "Move a copy of sites you visited in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.reading_list": {
-"description": "Move a copy of pages you added to your reading list in Chrome."
+"description": "Move a copy of pages you added to your reading list in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.settings": {
-"description": "Move a copy of your settings in Chrome."
+"description": "Move a copy of your settings in Chrome"
},
"https://www.googleapis.com/auth/dataportability.discover.follows": {
-"description": "Move a copy of searches and sites you follow, saved by Discover."
+"description": "Move a copy of searches and sites you follow, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.discover.likes": {
-"description": "Move a copy of links to your liked documents, saved by Discover."
+"description": "Move a copy of links to your liked documents, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.discover.not_interested": {
-"description": "Move a copy of content you marked as not interested, saved by Discover."
+"description": "Move a copy of content you marked as not interested, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.maps.aliased_places": {
-"description": "Move a copy of the places you labeled on Maps."
+"description": "Move a copy of the places you labeled on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.commute_routes": {
-"description": "Move a copy of your pinned trips on Maps."
+"description": "Move a copy of your pinned trips on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.commute_settings": {
-"description": "Move a copy of your commute settings on Maps."
+"description": "Move a copy of your commute settings on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.ev_profile": {
-"description": "Move a copy of your electric vehicle profile on Maps."
+"description": "Move a copy of your electric vehicle profile on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.factual_contributions": {
-"description": "Move a copy of the corrections you made to places or map information on Maps."
+"description": "Move a copy of the corrections you made to places or map information on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.offering_contributions": {
-"description": "Move a copy of your updates to places on Maps."
+"description": "Move a copy of your updates to places on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.photos_videos": {
-"description": "Move a copy of the photos and videos you posted on Maps."
+"description": "Move a copy of the photos and videos you posted on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.questions_answers": {
-"description": "Move a copy of the questions and answers you posted on Maps."
+"description": "Move a copy of the questions and answers you posted on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.reviews": {
-"description": "Move a copy of your reviews and posts on Maps."
+"description": "Move a copy of your reviews and posts on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.starred_places": {
-"description": "Move a copy of your Starred places list on Maps."
+"description": "Move a copy of your Starred places list on Maps"
},
"https://www.googleapis.com/auth/dataportability.myactivity.maps": {
-"description": "Move a copy of your Maps activity."
+"description": "Move a copy of your Maps activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.myadcenter": {
-"description": "Move a copy of your My Ad Center activity."
+"description": "Move a copy of your My Ad Center activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.play": {
-"description": "Move a copy of your Google Play activity."
+"description": "Move a copy of your Google Play activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.search": {
-"description": "Move a copy of your Google Search activity."
+"description": "Move a copy of your Google Search activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.shopping": {
-"description": "Move a copy of your Shopping activity."
+"description": "Move a copy of your Shopping activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.youtube": {
-"description": "Move a copy of your YouTube activity."
+"description": "Move a copy of your YouTube activity"
},
"https://www.googleapis.com/auth/dataportability.mymaps.maps": {
-"description": "Move a copy of the maps you created in My Maps."
+"description": "Move a copy of the maps you created in My Maps"
},
"https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": {
-"description": "Move a copy of your food purchase and reservation activity."
+"description": "Move a copy of your food purchase and reservation activity"
},
"https://www.googleapis.com/auth/dataportability.play.devices": {
-"description": "Move a copy of information about your devices with Google Play Store installed."
+"description": "Move a copy of information about your devices with Google Play Store installed"
},
"https://www.googleapis.com/auth/dataportability.play.grouping": {
-"description": "Move a copy of your Google Play Store Grouping tags created by app developers."
+"description": "Move a copy of your Google Play Store Grouping tags created by app developers"
},
"https://www.googleapis.com/auth/dataportability.play.installs": {
-"description": "Move a copy of your Google Play Store app installations."
+"description": "Move a copy of your Google Play Store app installations"
},
"https://www.googleapis.com/auth/dataportability.play.library": {
-"description": "Move a copy of your Google Play Store downloads, including books, games, and apps."
+"description": "Move a copy of your Google Play Store downloads, including books, games, and apps"
},
"https://www.googleapis.com/auth/dataportability.play.playpoints": {
-"description": "Move a copy of information about your Google Play Store Points."
+"description": "Move a copy of information about your Google Play Store Points"
},
"https://www.googleapis.com/auth/dataportability.play.promotions": {
-"description": "Move a copy of information about your Google Play Store promotions."
+"description": "Move a copy of information about your Google Play Store promotions"
},
"https://www.googleapis.com/auth/dataportability.play.purchases": {
-"description": "Move a copy of your Google Play Store purchases."
+"description": "Move a copy of your Google Play Store purchases"
},
"https://www.googleapis.com/auth/dataportability.play.redemptions": {
-"description": "Move a copy of your Google Play Store redemption activities."
+"description": "Move a copy of your Google Play Store redemption activities"
},
"https://www.googleapis.com/auth/dataportability.play.subscriptions": {
-"description": "Move a copy of your Google Play Store subscriptions."
+"description": "Move a copy of your Google Play Store subscriptions"
},
"https://www.googleapis.com/auth/dataportability.play.usersettings": {
-"description": "Move a copy of your Google Play Store user settings and preferences."
+"description": "Move a copy of your Google Play Store user settings and preferences"
},
"https://www.googleapis.com/auth/dataportability.saved.collections": {
-"description": "Move a copy of your saved links, images, places, and collections from your use of Google services."
+"description": "Move a copy of your saved links, images, places, and collections from your use of Google services"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": {
-"description": "Move a copy of your media reviews on Google Search."
+"description": "Move a copy of your media reviews on Google Search"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers": {
-"description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV."
+"description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs": {
-"description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV."
+"description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.watched": {
-"description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV."
+"description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.searchnotifications.settings": {
-"description": "Move a copy of your notification settings on the Google Search app."
+"description": "Move a copy of your notification settings on the Google Search app"
},
"https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions": {
-"description": "Move a copy of your notification subscriptions on Google Search app."
+"description": "Move a copy of your notification subscriptions on Google Search app"
},
"https://www.googleapis.com/auth/dataportability.shopping.addresses": {
-"description": "Move a copy of your shipping information on Shopping."
+"description": "Move a copy of your shipping information on Shopping"
},
"https://www.googleapis.com/auth/dataportability.shopping.reviews": {
-"description": "Move a copy of reviews you wrote about products or online stores on Google Search."
+"description": "Move a copy of reviews you wrote about products or online stores on Google Search"
},
"https://www.googleapis.com/auth/dataportability.streetview.imagery": {
-"description": "Move a copy of the images and videos you uploaded to Street View."
+"description": "Move a copy of the images and videos you uploaded to Street View"
},
"https://www.googleapis.com/auth/dataportability.youtube.channel": {
-"description": "Move a copy of information about your YouTube channel."
+"description": "Move a copy of information about your YouTube channel"
},
"https://www.googleapis.com/auth/dataportability.youtube.clips": {
-"description": "Move a copy of your YouTube clips metadata."
+"description": "Move a copy of your YouTube clips metadata"
},
"https://www.googleapis.com/auth/dataportability.youtube.comments": {
-"description": "Move a copy of your YouTube comments."
+"description": "Move a copy of your YouTube comments"
},
"https://www.googleapis.com/auth/dataportability.youtube.live_chat": {
-"description": "Move a copy of your YouTube messages in live chat."
+"description": "Move a copy of your YouTube messages in live chat"
},
"https://www.googleapis.com/auth/dataportability.youtube.music": {
-"description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library."
+"description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library"
},
"https://www.googleapis.com/auth/dataportability.youtube.playable": {
-"description": "Move a copy of your YouTube playables saved game progress files."
+"description": "Move a copy of your YouTube playables saved game progress files"
},
"https://www.googleapis.com/auth/dataportability.youtube.posts": {
-"description": "Move a copy of your YouTube posts."
+"description": "Move a copy of your YouTube posts"
},
"https://www.googleapis.com/auth/dataportability.youtube.private_playlists": {
-"description": "Move a copy of your YouTube private playlists."
+"description": "Move a copy of your YouTube private playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.private_videos": {
-"description": "Move a copy of your private YouTube videos and information about them."
+"description": "Move a copy of your private YouTube videos and information about them"
},
"https://www.googleapis.com/auth/dataportability.youtube.public_playlists": {
-"description": "Move a copy of your public YouTube playlists."
+"description": "Move a copy of your public YouTube playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.public_videos": {
-"description": "Move a copy of your public YouTube videos and information about them."
+"description": "Move a copy of your public YouTube videos and information about them"
},
"https://www.googleapis.com/auth/dataportability.youtube.shopping": {
-"description": "Move a copy of your YouTube shopping wishlists, and wishlist items."
+"description": "Move a copy of your YouTube shopping wishlists, and wishlist items"
},
"https://www.googleapis.com/auth/dataportability.youtube.subscriptions": {
-"description": "Move a copy of your YouTube channel subscriptions, even if they're private."
+"description": "Move a copy of your YouTube channel subscriptions, even if they're private"
},
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists": {
-"description": "Move a copy of your unlisted YouTube playlists."
+"description": "Move a copy of your unlisted YouTube playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos": {
-"description": "Move a copy of your unlisted YouTube videos and information about them."
+"description": "Move a copy of your unlisted YouTube videos and information about them"
}
}
}
@@ -655,7 +655,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250114",
"rootUrl": "https://dataportability.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json
index 681f0f31dfc..d2d70019bc1 100644
--- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json
@@ -3,199 +3,199 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/dataportability.alerts.subscriptions": {
-"description": "Move a copy of the Google Alerts subscriptions you created."
+"description": "Move a copy of the Google Alerts subscriptions you created"
},
"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": {
-"description": "Move a copy of messages between you and the businesses you have conversations with across Google services."
+"description": "Move a copy of messages between you and the businesses you have conversations with across Google services"
},
"https://www.googleapis.com/auth/dataportability.chrome.autofill": {
-"description": "Move a copy of the information you entered into online forms in Chrome."
+"description": "Move a copy of the information you entered into online forms in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.bookmarks": {
-"description": "Move a copy of pages you bookmarked in Chrome."
+"description": "Move a copy of pages you bookmarked in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.dictionary": {
-"description": "Move a copy of words you added to Chrome's dictionary."
+"description": "Move a copy of words you added to Chrome's dictionary"
},
"https://www.googleapis.com/auth/dataportability.chrome.extensions": {
-"description": "Move a copy of extensions you installed from the Chrome Web Store."
+"description": "Move a copy of extensions you installed from the Chrome Web Store"
},
"https://www.googleapis.com/auth/dataportability.chrome.history": {
-"description": "Move a copy of sites you visited in Chrome."
+"description": "Move a copy of sites you visited in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.reading_list": {
-"description": "Move a copy of pages you added to your reading list in Chrome."
+"description": "Move a copy of pages you added to your reading list in Chrome"
},
"https://www.googleapis.com/auth/dataportability.chrome.settings": {
-"description": "Move a copy of your settings in Chrome."
+"description": "Move a copy of your settings in Chrome"
},
"https://www.googleapis.com/auth/dataportability.discover.follows": {
-"description": "Move a copy of searches and sites you follow, saved by Discover."
+"description": "Move a copy of searches and sites you follow, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.discover.likes": {
-"description": "Move a copy of links to your liked documents, saved by Discover."
+"description": "Move a copy of links to your liked documents, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.discover.not_interested": {
-"description": "Move a copy of content you marked as not interested, saved by Discover."
+"description": "Move a copy of content you marked as not interested, saved by Discover"
},
"https://www.googleapis.com/auth/dataportability.maps.aliased_places": {
-"description": "Move a copy of the places you labeled on Maps."
+"description": "Move a copy of the places you labeled on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.commute_routes": {
-"description": "Move a copy of your pinned trips on Maps."
+"description": "Move a copy of your pinned trips on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.commute_settings": {
-"description": "Move a copy of your commute settings on Maps."
+"description": "Move a copy of your commute settings on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.ev_profile": {
-"description": "Move a copy of your electric vehicle profile on Maps."
+"description": "Move a copy of your electric vehicle profile on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.factual_contributions": {
-"description": "Move a copy of the corrections you made to places or map information on Maps."
+"description": "Move a copy of the corrections you made to places or map information on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.offering_contributions": {
-"description": "Move a copy of your updates to places on Maps."
+"description": "Move a copy of your updates to places on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.photos_videos": {
-"description": "Move a copy of the photos and videos you posted on Maps."
+"description": "Move a copy of the photos and videos you posted on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.questions_answers": {
-"description": "Move a copy of the questions and answers you posted on Maps."
+"description": "Move a copy of the questions and answers you posted on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.reviews": {
-"description": "Move a copy of your reviews and posts on Maps."
+"description": "Move a copy of your reviews and posts on Maps"
},
"https://www.googleapis.com/auth/dataportability.maps.starred_places": {
-"description": "Move a copy of your Starred places list on Maps."
+"description": "Move a copy of your Starred places list on Maps"
},
"https://www.googleapis.com/auth/dataportability.myactivity.maps": {
-"description": "Move a copy of your Maps activity."
+"description": "Move a copy of your Maps activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.myadcenter": {
-"description": "Move a copy of your My Ad Center activity."
+"description": "Move a copy of your My Ad Center activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.play": {
-"description": "Move a copy of your Google Play activity."
+"description": "Move a copy of your Google Play activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.search": {
-"description": "Move a copy of your Google Search activity."
+"description": "Move a copy of your Google Search activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.shopping": {
-"description": "Move a copy of your Shopping activity."
+"description": "Move a copy of your Shopping activity"
},
"https://www.googleapis.com/auth/dataportability.myactivity.youtube": {
-"description": "Move a copy of your YouTube activity."
+"description": "Move a copy of your YouTube activity"
},
"https://www.googleapis.com/auth/dataportability.mymaps.maps": {
-"description": "Move a copy of the maps you created in My Maps."
+"description": "Move a copy of the maps you created in My Maps"
},
"https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": {
-"description": "Move a copy of your food purchase and reservation activity."
+"description": "Move a copy of your food purchase and reservation activity"
},
"https://www.googleapis.com/auth/dataportability.play.devices": {
-"description": "Move a copy of information about your devices with Google Play Store installed."
+"description": "Move a copy of information about your devices with Google Play Store installed"
},
"https://www.googleapis.com/auth/dataportability.play.grouping": {
-"description": "Move a copy of your Google Play Store Grouping tags created by app developers."
+"description": "Move a copy of your Google Play Store Grouping tags created by app developers"
},
"https://www.googleapis.com/auth/dataportability.play.installs": {
-"description": "Move a copy of your Google Play Store app installations."
+"description": "Move a copy of your Google Play Store app installations"
},
"https://www.googleapis.com/auth/dataportability.play.library": {
-"description": "Move a copy of your Google Play Store downloads, including books, games, and apps."
+"description": "Move a copy of your Google Play Store downloads, including books, games, and apps"
},
"https://www.googleapis.com/auth/dataportability.play.playpoints": {
-"description": "Move a copy of information about your Google Play Store Points."
+"description": "Move a copy of information about your Google Play Store Points"
},
"https://www.googleapis.com/auth/dataportability.play.promotions": {
-"description": "Move a copy of information about your Google Play Store promotions."
+"description": "Move a copy of information about your Google Play Store promotions"
},
"https://www.googleapis.com/auth/dataportability.play.purchases": {
-"description": "Move a copy of your Google Play Store purchases."
+"description": "Move a copy of your Google Play Store purchases"
},
"https://www.googleapis.com/auth/dataportability.play.redemptions": {
-"description": "Move a copy of your Google Play Store redemption activities."
+"description": "Move a copy of your Google Play Store redemption activities"
},
"https://www.googleapis.com/auth/dataportability.play.subscriptions": {
-"description": "Move a copy of your Google Play Store subscriptions."
+"description": "Move a copy of your Google Play Store subscriptions"
},
"https://www.googleapis.com/auth/dataportability.play.usersettings": {
-"description": "Move a copy of your Google Play Store user settings and preferences."
+"description": "Move a copy of your Google Play Store user settings and preferences"
},
"https://www.googleapis.com/auth/dataportability.saved.collections": {
-"description": "Move a copy of your saved links, images, places, and collections from your use of Google services."
+"description": "Move a copy of your saved links, images, places, and collections from your use of Google services"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": {
-"description": "Move a copy of your media reviews on Google Search."
+"description": "Move a copy of your media reviews on Google Search"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers": {
-"description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV."
+"description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs": {
-"description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV."
+"description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.search_ugc.media.watched": {
-"description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV."
+"description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV"
},
"https://www.googleapis.com/auth/dataportability.searchnotifications.settings": {
-"description": "Move a copy of your notification settings on the Google Search app."
+"description": "Move a copy of your notification settings on the Google Search app"
},
"https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions": {
-"description": "Move a copy of your notification subscriptions on Google Search app."
+"description": "Move a copy of your notification subscriptions on Google Search app"
},
"https://www.googleapis.com/auth/dataportability.shopping.addresses": {
-"description": "Move a copy of your shipping information on Shopping."
+"description": "Move a copy of your shipping information on Shopping"
},
"https://www.googleapis.com/auth/dataportability.shopping.reviews": {
-"description": "Move a copy of reviews you wrote about products or online stores on Google Search."
+"description": "Move a copy of reviews you wrote about products or online stores on Google Search"
},
"https://www.googleapis.com/auth/dataportability.streetview.imagery": {
-"description": "Move a copy of the images and videos you uploaded to Street View."
+"description": "Move a copy of the images and videos you uploaded to Street View"
},
"https://www.googleapis.com/auth/dataportability.youtube.channel": {
-"description": "Move a copy of information about your YouTube channel."
+"description": "Move a copy of information about your YouTube channel"
},
"https://www.googleapis.com/auth/dataportability.youtube.clips": {
-"description": "Move a copy of your YouTube clips metadata."
+"description": "Move a copy of your YouTube clips metadata"
},
"https://www.googleapis.com/auth/dataportability.youtube.comments": {
-"description": "Move a copy of your YouTube comments."
+"description": "Move a copy of your YouTube comments"
},
"https://www.googleapis.com/auth/dataportability.youtube.live_chat": {
-"description": "Move a copy of your YouTube messages in live chat."
+"description": "Move a copy of your YouTube messages in live chat"
},
"https://www.googleapis.com/auth/dataportability.youtube.music": {
-"description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library."
+"description": "Move a copy of your uploaded YouTube music tracks and your YouTube music library"
},
"https://www.googleapis.com/auth/dataportability.youtube.playable": {
-"description": "Move a copy of your YouTube playables saved game progress files."
+"description": "Move a copy of your YouTube playables saved game progress files"
},
"https://www.googleapis.com/auth/dataportability.youtube.posts": {
-"description": "Move a copy of your YouTube posts."
+"description": "Move a copy of your YouTube posts"
},
"https://www.googleapis.com/auth/dataportability.youtube.private_playlists": {
-"description": "Move a copy of your YouTube private playlists."
+"description": "Move a copy of your YouTube private playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.private_videos": {
-"description": "Move a copy of your private YouTube videos and information about them."
+"description": "Move a copy of your private YouTube videos and information about them"
},
"https://www.googleapis.com/auth/dataportability.youtube.public_playlists": {
-"description": "Move a copy of your public YouTube playlists."
+"description": "Move a copy of your public YouTube playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.public_videos": {
-"description": "Move a copy of your public YouTube videos and information about them."
+"description": "Move a copy of your public YouTube videos and information about them"
},
"https://www.googleapis.com/auth/dataportability.youtube.shopping": {
-"description": "Move a copy of your YouTube shopping wishlists, and wishlist items."
+"description": "Move a copy of your YouTube shopping wishlists, and wishlist items"
},
"https://www.googleapis.com/auth/dataportability.youtube.subscriptions": {
-"description": "Move a copy of your YouTube channel subscriptions, even if they're private."
+"description": "Move a copy of your YouTube channel subscriptions, even if they're private"
},
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists": {
-"description": "Move a copy of your unlisted YouTube playlists."
+"description": "Move a copy of your unlisted YouTube playlists"
},
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos": {
-"description": "Move a copy of your unlisted YouTube videos and information about them."
+"description": "Move a copy of your unlisted YouTube videos and information about them"
}
}
}
@@ -655,7 +655,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250114",
"rootUrl": "https://dataportability.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json
index 4db984f640b..ff136de336c 100644
--- a/googleapiclient/discovery_cache/documents/datastream.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastream.v1.json
@@ -1250,7 +1250,7 @@
}
}
},
-"revision": "20250101",
+"revision": "20250108",
"rootUrl": "https://datastream.googleapis.com/",
"schemas": {
"AppendOnly": {
@@ -2935,7 +2935,7 @@
"type": "string"
},
"clientKey": {
-"description": "Required. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream.",
+"description": "Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. Mutually exclusive with the `secret_manager_stored_client_key` field.",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
index 44d6c25845e..7bb8b0f7dfe 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
@@ -5272,7 +5272,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250116",
"rootUrl": "https://dialogflow.googleapis.com/",
"schemas": {
"GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -12152,7 +12152,7 @@ false
"type": "string"
},
"goal": {
-"description": "Required. High level description of the goal the playbook intend to accomplish.",
+"description": "Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.",
"type": "string"
},
"inputParameterDefinitions": {
@@ -12313,6 +12313,10 @@ false
"description": "Message of the Instruction of the playbook.",
"id": "GoogleCloudDialogflowCxV3beta1PlaybookInstruction",
"properties": {
+"guidelines": {
+"description": "General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. \"Always be polite\". It's valid for this text to be long and used instead of steps altogether.",
+"type": "string"
+},
"steps": {
"description": "Ordered list of step by step execution instructions to accomplish target goal.",
"items": {
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
index 490620a42bb..7fc8353ad57 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
@@ -6371,7 +6371,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250114",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -10557,6 +10557,10 @@
"$ref": "GoogleCloudDiscoveryengineV1FirestoreSource",
"description": "Firestore input source."
},
+"forceRefreshContent": {
+"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
+"type": "boolean"
+},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1GcsSource",
"description": "Cloud Storage location for the input content."
@@ -13476,7 +13480,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
"type": "object"
},
"isActionConfigured": {
@@ -14775,7 +14779,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
"type": "object"
},
"privateConnectivityProjectId": {
@@ -14865,7 +14869,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id.",
+"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
"type": "object"
}
},
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
index 46c43b9bc3b..ca6c291b61d 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
@@ -8552,7 +8552,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250114",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -11020,7 +11020,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
"type": "object"
},
"isActionConfigured": {
@@ -14073,7 +14073,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
"type": "object"
},
"privateConnectivityProjectId": {
@@ -14163,7 +14163,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id.",
+"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
"type": "object"
}
},
@@ -16381,6 +16381,10 @@
"$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
"description": "Firestore input source."
},
+"forceRefreshContent": {
+"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
+"type": "boolean"
+},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource",
"description": "Cloud Storage location for the input content."
@@ -17173,7 +17177,7 @@
"id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest",
"properties": {
"crawlRateScope": {
-"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name.",
+"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
}
},
@@ -18052,7 +18056,7 @@
"id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest",
"properties": {
"crawlRateScope": {
-"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name.",
+"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
}
},
@@ -19336,6 +19340,10 @@
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo",
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
},
+"suggestedQuery": {
+"description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).",
+"type": "string"
+},
"summary": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary",
"description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
@@ -19453,6 +19461,10 @@
"description": "Rewritten input query minus the extracted filters.",
"type": "string"
},
+"sqlRequest": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"description": "Optional. The SQL request that was generated from the natural language query understanding phase."
+},
"structuredExtractedFilter": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
"description": "The filters that were extracted from the input query represented in a structured form."
@@ -19460,6 +19472,17 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": {
+"description": "The SQL request that was generated from the natural language query understanding phase.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"properties": {
+"sqlQuery": {
+"description": "Optional. The SQL query in text format.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": {
"description": "The filters that were extracted from the input query represented in a structured form.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
@@ -20179,11 +20202,11 @@
"type": "integer"
},
"crawlRateScope": {
-"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `abc.com`. A host name example: `www.abc.com`. Please do not include `/` in the domain or host name.",
+"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
},
"crawlType": {
-"description": "Optional. Whether it\u2019s the crawl rate of user-triggered or auto-refresh.",
+"description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.",
"enum": [
"CRAWL_TYPE_UNSPECIFIED",
"USER_TRIGGERED",
@@ -20427,6 +20450,10 @@
},
"type": "array"
},
+"forceRefreshContent": {
+"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
+"type": "boolean"
+},
"healthcareFhirResourceTypes": {
"description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.",
"items": {
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
index cc5ead7b177..5bf06e6dea3 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
@@ -7384,7 +7384,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250114",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -9852,7 +9852,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
"type": "object"
},
"isActionConfigured": {
@@ -11151,7 +11151,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
"type": "object"
},
"privateConnectivityProjectId": {
@@ -11241,7 +11241,7 @@
"description": "Properties of the object.",
"type": "any"
},
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id.",
+"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
"type": "object"
}
},
@@ -18963,6 +18963,10 @@
"$ref": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
"description": "Firestore input source."
},
+"forceRefreshContent": {
+"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
+"type": "boolean"
+},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content."
@@ -21305,6 +21309,10 @@
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
},
+"suggestedQuery": {
+"description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).",
+"type": "string"
+},
"summary": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
"description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
@@ -21422,6 +21430,10 @@
"description": "Rewritten input query minus the extracted filters.",
"type": "string"
},
+"sqlRequest": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"description": "Optional. The SQL request that was generated from the natural language query understanding phase."
+},
"structuredExtractedFilter": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
"description": "The filters that were extracted from the input query represented in a structured form."
@@ -21429,6 +21441,17 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": {
+"description": "The SQL request that was generated from the natural language query understanding phase.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"properties": {
+"sqlQuery": {
+"description": "Optional. The SQL query in text format.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": {
"description": "The filters that were extracted from the input query represented in a structured form.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
index fb72b019302..7ff8fe9b0c9 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
@@ -571,18 +571,18 @@
"https://www.googleapis.com/auth/display-video-mediaplanning"
]
},
-"listAssignedTargetingOptions": {
-"description": "Lists assigned targeting options of a campaign across targeting types.",
-"flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.campaigns.listAssignedTargetingOptions",
+"patch": {
+"description": "Updates an existing campaign. Returns the updated campaign if successful.",
+"flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}",
+"httpMethod": "PATCH",
+"id": "displayvideo.advertisers.campaigns.patch",
"parameterOrder": [
"advertiserId",
"campaignId"
],
"parameters": {
"advertiserId": {
-"description": "Required. The ID of the advertiser the campaign belongs to.",
+"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
@@ -590,268 +590,123 @@
"type": "string"
},
"campaignId": {
-"description": "Required. The ID of the campaign to list assigned targeting options for.",
+"description": "Output only. The unique ID of the campaign. Assigned by the system.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
-"filter": {
-"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType=\"TARGETING_TYPE_LANGUAGE\" OR targetingType=\"TARGETING_TYPE_GENDER\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
+"updateMask": {
+"description": "Required. The mask to control which fields to update.",
+"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
-"path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions",
+"path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}",
+"request": {
+"$ref": "Campaign"
+},
"response": {
-"$ref": "BulkListCampaignAssignedTargetingOptionsResponse"
+"$ref": "Campaign"
},
"scopes": [
-"https://www.googleapis.com/auth/display-video"
+"https://www.googleapis.com/auth/display-video",
+"https://www.googleapis.com/auth/display-video-mediaplanning"
]
+}
+}
},
-"patch": {
-"description": "Updates an existing campaign. Returns the updated campaign if successful.",
-"flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}",
-"httpMethod": "PATCH",
-"id": "displayvideo.advertisers.campaigns.patch",
+"channels": {
+"methods": {
+"create": {
+"description": "Creates a new channel. Returns the newly created channel if successful.",
+"flatPath": "v2/advertisers/{advertisersId}/channels",
+"httpMethod": "POST",
+"id": "displayvideo.advertisers.channels.create",
"parameterOrder": [
-"advertiserId",
-"campaignId"
+"advertiserId"
],
"parameters": {
"advertiserId": {
-"description": "Output only. The unique ID of the advertiser the campaign belongs to.",
+"description": "The ID of the advertiser that owns the created channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
-"campaignId": {
-"description": "Output only. The unique ID of the campaign. Assigned by the system.",
+"partnerId": {
+"description": "The ID of the partner that owns the created channel.",
"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. The mask to control which fields to update.",
-"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
-"path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}",
+"path": "v2/advertisers/{+advertiserId}/channels",
"request": {
-"$ref": "Campaign"
+"$ref": "Channel"
},
"response": {
-"$ref": "Campaign"
+"$ref": "Channel"
},
"scopes": [
-"https://www.googleapis.com/auth/display-video",
-"https://www.googleapis.com/auth/display-video-mediaplanning"
+"https://www.googleapis.com/auth/display-video"
]
-}
},
-"resources": {
-"targetingTypes": {
-"resources": {
-"assignedTargetingOptions": {
-"methods": {
"get": {
-"description": "Gets a single targeting option assigned to a campaign.",
-"flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
+"description": "Gets a channel for a partner or advertiser.",
+"flatPath": "v2/advertisers/{advertisersId}/channels/{channelsId}",
"httpMethod": "GET",
-"id": "displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get",
+"id": "displayvideo.advertisers.channels.get",
"parameterOrder": [
"advertiserId",
-"campaignId",
-"targetingType",
-"assignedTargetingOptionId"
+"channelId"
],
"parameters": {
"advertiserId": {
-"description": "Required. The ID of the advertiser the campaign belongs to.",
+"description": "The ID of the advertiser that owns the fetched channel.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
-"assignedTargetingOptionId": {
-"description": "Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested.",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"campaignId": {
-"description": "Required. The ID of the campaign the assigned targeting option belongs to.",
+"channelId": {
+"description": "Required. The ID of the channel to fetch.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
-"targetingType": {
-"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
-],
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
+"partnerId": {
+"description": "The ID of the partner that owns the fetched channel.",
+"format": "int64",
+"location": "query",
"type": "string"
}
},
-"path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
+"path": "v2/advertisers/{+advertiserId}/channels/{+channelId}",
"response": {
-"$ref": "AssignedTargetingOption"
+"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
},
"list": {
-"description": "Lists the targeting options assigned to a campaign for a specified targeting type.",
-"flatPath": "v2/advertisers/{advertisersId}/campaigns/{campaignsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
+"description": "Lists channels for a partner or advertiser.",
+"flatPath": "v2/advertisers/{advertisersId}/channels",
"httpMethod": "GET",
-"id": "displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list",
+"id": "displayvideo.advertisers.channels.list",
"parameterOrder": [
-"advertiserId",
-"campaignId",
-"targetingType"
+"advertiserId"
],
"parameters": {
"advertiserId": {
-"description": "Required. The ID of the advertiser the campaign belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"campaignId": {
-"description": "Required. The ID of the campaign to list assigned targeting options for.",
+"description": "The ID of the advertiser that owns the channels.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
@@ -859,263 +714,23 @@
"type": "string"
},
"filter": {
-"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
+"description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
"location": "query",
"type": "string"
},
"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.",
+"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.",
"location": "query",
"type": "string"
},
"pageSize": {
-"description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
+"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-},
-"targetingType": {
-"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
-],
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
-"response": {
-"$ref": "ListCampaignAssignedTargetingOptionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-}
-}
-}
-}
-}
-}
-},
-"channels": {
-"methods": {
-"create": {
-"description": "Creates a new channel. Returns the newly created channel if successful.",
-"flatPath": "v2/advertisers/{advertisersId}/channels",
-"httpMethod": "POST",
-"id": "displayvideo.advertisers.channels.create",
-"parameterOrder": [
-"advertiserId"
-],
-"parameters": {
-"advertiserId": {
-"description": "The ID of the advertiser that owns the created channel.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"partnerId": {
-"description": "The ID of the partner that owns the created channel.",
-"format": "int64",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/channels",
-"request": {
-"$ref": "Channel"
-},
-"response": {
-"$ref": "Channel"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"get": {
-"description": "Gets a channel for a partner or advertiser.",
-"flatPath": "v2/advertisers/{advertisersId}/channels/{channelsId}",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.channels.get",
-"parameterOrder": [
-"advertiserId",
-"channelId"
-],
-"parameters": {
-"advertiserId": {
-"description": "The ID of the advertiser that owns the fetched channel.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"channelId": {
-"description": "Required. The ID of the channel to fetch.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"partnerId": {
-"description": "The ID of the partner that owns the fetched channel.",
-"format": "int64",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/channels/{+channelId}",
-"response": {
-"$ref": "Channel"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"list": {
-"description": "Lists channels for a partner or advertiser.",
-"flatPath": "v2/advertisers/{advertisersId}/channels",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.channels.list",
-"parameterOrder": [
-"advertiserId"
-],
-"parameters": {
-"advertiserId": {
-"description": "The ID of the advertiser that owns the channels.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"filter": {
-"description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.",
+"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
},
@@ -1674,821 +1289,135 @@
"response": {
"$ref": "Empty"
},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"get": {
-"description": "Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.insertionOrders.get",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser this insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order to fetch.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
-"response": {
-"$ref": "InsertionOrder"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"list": {
-"description": "Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.insertionOrders.list",
-"parameterOrder": [
-"advertiserId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser to list insertion orders for.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"filter": {
-"description": "Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders",
-"response": {
-"$ref": "ListInsertionOrdersResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"listAssignedTargetingOptions": {
-"description": "Lists assigned targeting options of an insertion order across targeting types.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}:listAssignedTargetingOptions",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"filter": {
-"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order to list assigned targeting options for.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions",
-"response": {
-"$ref": "BulkListInsertionOrderAssignedTargetingOptionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"patch": {
-"description": "Updates an existing insertion order. Returns the updated insertion order if successful.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
-"httpMethod": "PATCH",
-"id": "displayvideo.advertisers.insertionOrders.patch",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Output only. The unique ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Output only. The unique ID of the insertion order. Assigned by the system.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. The mask to control which fields to update.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
-"request": {
-"$ref": "InsertionOrder"
-},
-"response": {
-"$ref": "InsertionOrder"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-}
-},
-"resources": {
-"targetingTypes": {
-"resources": {
-"assignedTargetingOptions": {
-"methods": {
-"create": {
-"description": "Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
-"httpMethod": "POST",
-"id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId",
-"targetingType"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order the assigned targeting option will belong to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"targetingType": {
-"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
-],
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
-"request": {
-"$ref": "AssignedTargetingOption"
-},
-"response": {
-"$ref": "AssignedTargetingOption"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"delete": {
-"description": "Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
-"httpMethod": "DELETE",
-"id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId",
-"targetingType",
-"assignedTargetingOptionId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"assignedTargetingOptionId": {
-"description": "Required. The ID of the assigned targeting option to delete.",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order the assigned targeting option belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"targetingType": {
-"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
-],
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
-"response": {
-"$ref": "Empty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"get": {
-"description": "Gets a single targeting option assigned to an insertion order.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId",
-"targetingType",
-"assignedTargetingOptionId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"assignedTargetingOptionId": {
-"description": "Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested.",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order the assigned targeting option belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"targetingType": {
-"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
-],
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}",
-"response": {
-"$ref": "AssignedTargetingOption"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"list": {
-"description": "Lists the targeting options assigned to an insertion order.",
-"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions",
-"httpMethod": "GET",
-"id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list",
-"parameterOrder": [
-"advertiserId",
-"insertionOrderId",
-"targetingType"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser the insertion order belongs to.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"filter": {
-"description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"insertionOrderId": {
-"description": "Required. The ID of the insertion order to list assigned targeting options for.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-},
-"targetingType": {
-"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`",
-"enum": [
-"TARGETING_TYPE_UNSPECIFIED",
-"TARGETING_TYPE_CHANNEL",
-"TARGETING_TYPE_APP_CATEGORY",
-"TARGETING_TYPE_APP",
-"TARGETING_TYPE_URL",
-"TARGETING_TYPE_DAY_AND_TIME",
-"TARGETING_TYPE_AGE_RANGE",
-"TARGETING_TYPE_REGIONAL_LOCATION_LIST",
-"TARGETING_TYPE_PROXIMITY_LOCATION_LIST",
-"TARGETING_TYPE_GENDER",
-"TARGETING_TYPE_VIDEO_PLAYER_SIZE",
-"TARGETING_TYPE_USER_REWARDED_CONTENT",
-"TARGETING_TYPE_PARENTAL_STATUS",
-"TARGETING_TYPE_CONTENT_INSTREAM_POSITION",
-"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION",
-"TARGETING_TYPE_DEVICE_TYPE",
-"TARGETING_TYPE_AUDIENCE_GROUP",
-"TARGETING_TYPE_BROWSER",
-"TARGETING_TYPE_HOUSEHOLD_INCOME",
-"TARGETING_TYPE_ON_SCREEN_POSITION",
-"TARGETING_TYPE_THIRD_PARTY_VERIFIER",
-"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION",
-"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION",
-"TARGETING_TYPE_ENVIRONMENT",
-"TARGETING_TYPE_CARRIER_AND_ISP",
-"TARGETING_TYPE_OPERATING_SYSTEM",
-"TARGETING_TYPE_DEVICE_MAKE_MODEL",
-"TARGETING_TYPE_KEYWORD",
-"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST",
-"TARGETING_TYPE_VIEWABILITY",
-"TARGETING_TYPE_CATEGORY",
-"TARGETING_TYPE_INVENTORY_SOURCE",
-"TARGETING_TYPE_LANGUAGE",
-"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS",
-"TARGETING_TYPE_GEO_REGION",
-"TARGETING_TYPE_INVENTORY_SOURCE_GROUP",
-"TARGETING_TYPE_EXCHANGE",
-"TARGETING_TYPE_SUB_EXCHANGE",
-"TARGETING_TYPE_POI",
-"TARGETING_TYPE_BUSINESS_CHAIN",
-"TARGETING_TYPE_CONTENT_DURATION",
-"TARGETING_TYPE_CONTENT_STREAM_TYPE",
-"TARGETING_TYPE_NATIVE_CONTENT_POSITION",
-"TARGETING_TYPE_OMID",
-"TARGETING_TYPE_AUDIO_CONTENT_TYPE",
-"TARGETING_TYPE_CONTENT_GENRE",
-"TARGETING_TYPE_YOUTUBE_VIDEO",
-"TARGETING_TYPE_YOUTUBE_CHANNEL",
-"TARGETING_TYPE_SESSION_POSITION"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown in this version.",
-"Target a channel (a custom group of related websites or apps).",
-"Target an app category (for example, education or puzzle games).",
-"Target a specific app (for example, Angry Birds).",
-"Target a specific url (for example, quora.com).",
-"Target ads during a chosen time period on a specific day.",
-"Target ads to a specific age range (for example, 18-24).",
-"Target ads to the specified regions on a regional location list.",
-"Target ads to the specified points of interest on a proximity location list.",
-"Target ads to a specific gender (for example, female or male).",
-"Target a specific video player size for video ads.",
-"Target user rewarded content for video ads.",
-"Target ads to a specific parental status (for example, parent or not a parent).",
-"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).",
-"Target ads in a specific content outstream position.",
-"Target ads to a specific device type (for example, tablet or connected TV).",
-"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.",
-"Target ads to specific web browsers (for example, Chrome).",
-"Target ads to a specific household income range (for example, top 10%).",
-"Target ads in a specific on screen position.",
-"Filter web sites through third party verification (for example, IAS or DoubleVerify).",
-"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).",
-"Filter website content by sensitive categories (for example, adult).",
-"Target ads to a specific environment (for example, web or app).",
-"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).",
-"Target ads to a specific operating system (for example, macOS).",
-"Target ads to a specific device make or model (for example, Roku or Samsung).",
-"Target ads to a specific keyword (for example, dog or retriever).",
-"Target ads to a specific negative keyword list.",
-"Target ads to a specific viewability (for example, 80% viewable).",
-"Target ads to a specific content category (for example, arts & entertainment).",
-"Purchase impressions from specific deals and auction packages.",
-"Target ads to a specific language (for example, English or Japanese).",
-"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.",
-"Target ads to a specific regional location (for example, a city or state).",
-"Purchase impressions from a group of deals and auction packages.",
-"Purchase impressions from specific exchanges.",
-"Purchase impressions from specific sub-exchanges.",
-"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.",
-"Target ads around locations of a business chain within a specific geo region.",
-"Target ads to a specific video content duration.",
-"Target ads to a specific video content stream type.",
-"Target ads to a specific native content position.",
-"Target ads in an Open Measurement enabled inventory.",
-"Target ads to a specific audio content type.",
-"Target ads to a specific content genre.",
-"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.",
-"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API."
+"scopes": [
+"https://www.googleapis.com/auth/display-video"
+]
+},
+"get": {
+"description": "Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist.",
+"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
+"httpMethod": "GET",
+"id": "displayvideo.advertisers.insertionOrders.get",
+"parameterOrder": [
+"advertiserId",
+"insertionOrderId"
],
+"parameters": {
+"advertiserId": {
+"description": "Required. The ID of the advertiser this insertion order belongs to.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+},
+"insertionOrderId": {
+"description": "Required. The ID of the insertion order to fetch.",
+"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
-"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions",
+"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
"response": {
-"$ref": "ListInsertionOrderAssignedTargetingOptionsResponse"
+"$ref": "InsertionOrder"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
]
+},
+"list": {
+"description": "Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.",
+"flatPath": "v2/advertisers/{advertisersId}/insertionOrders",
+"httpMethod": "GET",
+"id": "displayvideo.advertisers.insertionOrders.list",
+"parameterOrder": [
+"advertiserId"
+],
+"parameters": {
+"advertiserId": {
+"description": "Required. The ID of the advertiser to list insertion orders for.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+},
+"filter": {
+"description": "Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.",
+"location": "query",
+"type": "string"
}
+},
+"path": "v2/advertisers/{+advertiserId}/insertionOrders",
+"response": {
+"$ref": "ListInsertionOrdersResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/display-video"
+]
+},
+"patch": {
+"description": "Updates an existing insertion order. Returns the updated insertion order if successful.",
+"flatPath": "v2/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}",
+"httpMethod": "PATCH",
+"id": "displayvideo.advertisers.insertionOrders.patch",
+"parameterOrder": [
+"advertiserId",
+"insertionOrderId"
+],
+"parameters": {
+"advertiserId": {
+"description": "Output only. The unique ID of the advertiser the insertion order belongs to.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+},
+"insertionOrderId": {
+"description": "Output only. The unique ID of the insertion order. Assigned by the system.",
+"format": "int64",
+"location": "path",
+"pattern": "^[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The mask to control which fields to update.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
}
-}
-}
+},
+"path": "v2/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}",
+"request": {
+"$ref": "InsertionOrder"
+},
+"response": {
+"$ref": "InsertionOrder"
+},
+"scopes": [
+"https://www.googleapis.com/auth/display-video"
+]
}
}
},
@@ -6178,211 +5107,25 @@
"type": "string"
},
"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/customLists",
-"response": {
-"$ref": "ListCustomListsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-}
-}
-},
-"firstAndThirdPartyAudiences": {
-"methods": {
-"create": {
-"description": "Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`",
-"flatPath": "v2/firstAndThirdPartyAudiences",
-"httpMethod": "POST",
-"id": "displayvideo.firstAndThirdPartyAudiences.create",
-"parameterOrder": [],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.",
-"format": "int64",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/firstAndThirdPartyAudiences",
-"request": {
-"$ref": "FirstAndThirdPartyAudience"
-},
-"response": {
-"$ref": "FirstAndThirdPartyAudience"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"editCustomerMatchMembers": {
-"description": "Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`",
-"flatPath": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers",
-"httpMethod": "POST",
-"id": "displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers",
-"parameterOrder": [
-"firstAndThirdPartyAudienceId"
-],
-"parameters": {
-"firstAndThirdPartyAudienceId": {
-"description": "Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers",
-"request": {
-"$ref": "EditCustomerMatchMembersRequest"
-},
-"response": {
-"$ref": "EditCustomerMatchMembersResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"get": {
-"description": "Gets a first and third party audience.",
-"flatPath": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}",
-"httpMethod": "GET",
-"id": "displayvideo.firstAndThirdPartyAudiences.get",
-"parameterOrder": [
-"firstAndThirdPartyAudienceId"
-],
-"parameters": {
-"advertiserId": {
-"description": "The ID of the advertiser that has access to the fetched first and third party audience.",
-"format": "int64",
-"location": "query",
-"type": "string"
-},
-"firstAndThirdPartyAudienceId": {
-"description": "Required. The ID of the first and third party audience to fetch.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
-},
-"partnerId": {
-"description": "The ID of the partner that has access to the fetched first and third party audience.",
-"format": "int64",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}",
-"response": {
-"$ref": "FirstAndThirdPartyAudience"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"list": {
-"description": "Lists first and third party audiences. The order is defined by the order_by parameter.",
-"flatPath": "v2/firstAndThirdPartyAudiences",
-"httpMethod": "GET",
-"id": "displayvideo.firstAndThirdPartyAudiences.list",
-"parameterOrder": [],
-"parameters": {
-"advertiserId": {
-"description": "The ID of the advertiser that has access to the fetched first and third party audiences.",
-"format": "int64",
-"location": "query",
-"type": "string"
-},
-"filter": {
-"description": "Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.",
-"location": "query",
-"type": "string"
-},
-"partnerId": {
-"description": "The ID of the partner that has access to the fetched first and third party audiences.",
-"format": "int64",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v2/firstAndThirdPartyAudiences",
-"response": {
-"$ref": "ListFirstAndThirdPartyAudiencesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/display-video"
-]
-},
-"patch": {
-"description": "Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`",
-"flatPath": "v2/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}",
-"httpMethod": "PATCH",
-"id": "displayvideo.firstAndThirdPartyAudiences.patch",
-"parameterOrder": [
-"firstAndThirdPartyAudienceId"
-],
-"parameters": {
-"advertiserId": {
-"description": "Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.",
-"format": "int64",
+"description": "Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.",
"location": "query",
"type": "string"
},
-"firstAndThirdPartyAudienceId": {
-"description": "Output only. The unique ID of the first and third party audience. Assigned by the system.",
-"format": "int64",
-"location": "path",
-"pattern": "^[^/]+$",
-"required": true,
-"type": "string"
+"pageSize": {
+"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.",
+"format": "int32",
+"location": "query",
+"type": "integer"
},
-"updateMask": {
-"description": "Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`",
-"format": "google-fieldmask",
+"pageToken": {
+"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.",
"location": "query",
"type": "string"
}
},
-"path": "v2/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}",
-"request": {
-"$ref": "FirstAndThirdPartyAudience"
-},
+"path": "v2/customLists",
"response": {
-"$ref": "FirstAndThirdPartyAudience"
+"$ref": "ListCustomListsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/display-video"
@@ -9267,7 +8010,7 @@
}
}
},
-"revision": "20241212",
+"revision": "20250115",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActivateManualTriggerRequest": {
@@ -11028,40 +9771,6 @@
},
"type": "object"
},
-"BulkListCampaignAssignedTargetingOptionsResponse": {
-"id": "BulkListCampaignAssignedTargetingOptionsResponse",
-"properties": {
-"assignedTargetingOptions": {
-"description": "The list of assigned targeting options. This list will be absent if empty.",
-"items": {
-"$ref": "AssignedTargetingOption"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.",
-"type": "string"
-}
-},
-"type": "object"
-},
-"BulkListInsertionOrderAssignedTargetingOptionsResponse": {
-"id": "BulkListInsertionOrderAssignedTargetingOptionsResponse",
-"properties": {
-"assignedTargetingOptions": {
-"description": "The list of assigned targeting options. This list will be absent if empty.",
-"items": {
-"$ref": "AssignedTargetingOption"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.",
-"type": "string"
-}
-},
-"type": "object"
-},
"BulkUpdateLineItemsRequest": {
"description": "Request message for LineItemService.BulkUpdateLineItems.",
"id": "BulkUpdateLineItemsRequest",
@@ -11743,99 +10452,6 @@
},
"type": "object"
},
-"Consent": {
-"description": "User consent status.",
-"id": "Consent",
-"properties": {
-"adPersonalization": {
-"description": "Represents consent for ad personalization.",
-"enum": [
-"CONSENT_STATUS_UNSPECIFIED",
-"CONSENT_STATUS_GRANTED",
-"CONSENT_STATUS_DENIED"
-],
-"enumDescriptions": [
-"Type value is not specified or is unknown in this version.",
-"Consent is granted.",
-"Consent is denied."
-],
-"type": "string"
-},
-"adUserData": {
-"description": "Represents consent for ad user data.",
-"enum": [
-"CONSENT_STATUS_UNSPECIFIED",
-"CONSENT_STATUS_GRANTED",
-"CONSENT_STATUS_DENIED"
-],
-"enumDescriptions": [
-"Type value is not specified or is unknown in this version.",
-"Consent is granted.",
-"Consent is denied."
-],
-"type": "string"
-}
-},
-"type": "object"
-},
-"ContactInfo": {
-"description": "Contact information defining a Customer Match audience member.",
-"id": "ContactInfo",
-"properties": {
-"countryCode": {
-"description": "Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes",
-"type": "string"
-},
-"hashedEmails": {
-"description": "A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.",
-"items": {
-"type": "string"
-},
-"type": "array"
-},
-"hashedFirstName": {
-"description": "SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes",
-"type": "string"
-},
-"hashedLastName": {
-"description": "SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes",
-"type": "string"
-},
-"hashedPhoneNumbers": {
-"description": "A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.",
-"items": {
-"type": "string"
-},
-"type": "array"
-},
-"zipCodes": {
-"description": "A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"ContactInfoList": {
-"description": "Wrapper message for a list of contact information defining Customer Match audience members.",
-"id": "ContactInfoList",
-"properties": {
-"consent": {
-"$ref": "Consent",
-"description": "Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error."
-},
-"contactInfos": {
-"description": "A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.",
-"items": {
-"$ref": "ContactInfo"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
"ContentDurationAssignedTargetingOptionDetails": {
"description": "Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect.",
"id": "ContentDurationAssignedTargetingOptionDetails",
@@ -13852,46 +12468,6 @@ false
},
"type": "object"
},
-"EditCustomerMatchMembersRequest": {
-"description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.",
-"id": "EditCustomerMatchMembersRequest",
-"properties": {
-"addedContactInfoList": {
-"$ref": "ContactInfoList",
-"description": "Input only. A list of contact information to define the members to be added."
-},
-"addedMobileDeviceIdList": {
-"$ref": "MobileDeviceIdList",
-"description": "Input only. A list of mobile device IDs to define the members to be added."
-},
-"advertiserId": {
-"description": "Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.",
-"format": "int64",
-"type": "string"
-},
-"removedContactInfoList": {
-"$ref": "ContactInfoList",
-"description": "Input only. A list of contact information to define the members to be removed."
-},
-"removedMobileDeviceIdList": {
-"$ref": "MobileDeviceIdList",
-"description": "Input only. A list of mobile device IDs to define the members to be removed."
-}
-},
-"type": "object"
-},
-"EditCustomerMatchMembersResponse": {
-"description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.",
-"id": "EditCustomerMatchMembersResponse",
-"properties": {
-"firstAndThirdPartyAudienceId": {
-"description": "Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.",
-"format": "int64",
-"type": "string"
-}
-},
-"type": "object"
-},
"EditGuaranteedOrderReadAccessorsRequest": {
"description": "Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.",
"id": "EditGuaranteedOrderReadAccessorsRequest",
@@ -14857,165 +13433,6 @@ false
},
"type": "object"
},
-"FirstAndThirdPartyAudience": {
-"description": "Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.",
-"id": "FirstAndThirdPartyAudience",
-"properties": {
-"activeDisplayAudienceSize": {
-"description": "Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"appId": {
-"description": "The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`",
-"type": "string"
-},
-"audienceSource": {
-"description": "Output only. The source of the audience.",
-"enum": [
-"AUDIENCE_SOURCE_UNSPECIFIED",
-"DISPLAY_VIDEO_360",
-"CAMPAIGN_MANAGER",
-"AD_MANAGER",
-"SEARCH_ADS_360",
-"YOUTUBE",
-"ADS_DATA_HUB"
-],
-"enumDescriptions": [
-"Default value when audience source is not specified or is unknown.",
-"Originated from Display & Video 360.",
-"Originated from Campaign Manager 360.",
-"Originated from Google Ad Manager.",
-"Originated from Search Ads 360.",
-"Originated from Youtube.",
-"Originated from Ads Data Hub."
-],
-"readOnly": true,
-"type": "string"
-},
-"audienceType": {
-"description": "The type of the audience.",
-"enum": [
-"AUDIENCE_TYPE_UNSPECIFIED",
-"CUSTOMER_MATCH_CONTACT_INFO",
-"CUSTOMER_MATCH_DEVICE_ID",
-"CUSTOMER_MATCH_USER_ID",
-"ACTIVITY_BASED",
-"FREQUENCY_CAP",
-"TAG_BASED",
-"YOUTUBE_USERS",
-"LICENSED"
-],
-"enumDeprecated": [
-false,
-false,
-false,
-false,
-true,
-true,
-false,
-false,
-false
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown.",
-"Audience was generated through matching customers to known contact information.",
-"Audience was generated through matching customers to known Mobile device IDs.",
-"Audience was generated through matching customers to known User IDs.",
-"Audience was created based on campaign activity.",
-"Audience was created based on excluding the number of impressions they were served.",
-"Audience was created based on custom variables attached to pixel.",
-"Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.",
-"Subtype of third party audience type."
-],
-"type": "string"
-},
-"contactInfoList": {
-"$ref": "ContactInfoList",
-"description": "Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`"
-},
-"description": {
-"description": "The user-provided description of the audience. Only applicable to first party audiences.",
-"type": "string"
-},
-"displayAudienceSize": {
-"description": "Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"displayDesktopAudienceSize": {
-"description": "Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"displayMobileAppAudienceSize": {
-"description": "Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"displayMobileWebAudienceSize": {
-"description": "Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"displayName": {
-"description": "The display name of the first and third party audience.",
-"type": "string"
-},
-"firstAndThirdPartyAudienceId": {
-"description": "Output only. The unique ID of the first and third party audience. Assigned by the system.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"firstAndThirdPartyAudienceType": {
-"description": "Whether the audience is a first or third party audience.",
-"enum": [
-"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED",
-"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY",
-"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY"
-],
-"enumDescriptions": [
-"Default value when type is not specified or is unknown.",
-"Audience that is created via usage of client data.",
-"Audience that is provided by Third Party data providers."
-],
-"type": "string"
-},
-"gmailAudienceSize": {
-"description": "Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-},
-"membershipDurationDays": {
-"description": "The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`",
-"format": "int64",
-"type": "string"
-},
-"mobileDeviceIdList": {
-"$ref": "MobileDeviceIdList",
-"description": "Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`"
-},
-"name": {
-"description": "Output only. The resource name of the first and third party audience.",
-"readOnly": true,
-"type": "string"
-},
-"youtubeAudienceSize": {
-"description": "Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.",
-"format": "int64",
-"readOnly": true,
-"type": "string"
-}
-},
-"type": "object"
-},
"FirstAndThirdPartyAudienceGroup": {
"description": "Details of first and third party audience group. All first and third party audience targeting settings are logically \u2018OR\u2019 of each other.",
"id": "FirstAndThirdPartyAudienceGroup",
@@ -16349,7 +14766,7 @@ true
"id": "IntegralAdScience",
"properties": {
"customSegmentId": {
-"description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.",
+"description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.",
"items": {
"format": "int64",
"type": "string"
@@ -17639,24 +16056,6 @@ true
},
"type": "object"
},
-"ListCampaignAssignedTargetingOptionsResponse": {
-"description": "Response message for ListCampaignAssignedTargetingOptions.",
-"id": "ListCampaignAssignedTargetingOptionsResponse",
-"properties": {
-"assignedTargetingOptions": {
-"description": "The list of assigned targeting options. This list will be absent if empty.",
-"items": {
-"$ref": "AssignedTargetingOption"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.",
-"type": "string"
-}
-},
-"type": "object"
-},
"ListCampaignsResponse": {
"id": "ListCampaignsResponse",
"properties": {
@@ -17776,23 +16175,6 @@ true
},
"type": "object"
},
-"ListFirstAndThirdPartyAudiencesResponse": {
-"id": "ListFirstAndThirdPartyAudiencesResponse",
-"properties": {
-"firstAndThirdPartyAudiences": {
-"description": "The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.",
-"items": {
-"$ref": "FirstAndThirdPartyAudience"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results.",
-"type": "string"
-}
-},
-"type": "object"
-},
"ListFloodlightActivitiesResponse": {
"id": "ListFloodlightActivitiesResponse",
"properties": {
@@ -17844,23 +16226,6 @@ true
},
"type": "object"
},
-"ListInsertionOrderAssignedTargetingOptionsResponse": {
-"id": "ListInsertionOrderAssignedTargetingOptionsResponse",
-"properties": {
-"assignedTargetingOptions": {
-"description": "The list of assigned targeting options. This list will be absent if empty.",
-"items": {
-"$ref": "AssignedTargetingOption"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.",
-"type": "string"
-}
-},
-"type": "object"
-},
"ListInsertionOrdersResponse": {
"id": "ListInsertionOrdersResponse",
"properties": {
@@ -18457,24 +16822,6 @@ true
},
"type": "object"
},
-"MobileDeviceIdList": {
-"description": "Wrapper message for a list of mobile device IDs defining Customer Match audience members.",
-"id": "MobileDeviceIdList",
-"properties": {
-"consent": {
-"$ref": "Consent",
-"description": "Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error."
-},
-"mobileDeviceIds": {
-"description": "A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
"Money": {
"description": "Represents an amount of money with its currency type.",
"id": "Money",
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
index d64916286d4..7422d7294c7 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
@@ -9222,7 +9222,7 @@
}
}
},
-"revision": "20241212",
+"revision": "20250109",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActiveViewVideoViewabilityMetricConfig": {
@@ -17354,7 +17354,7 @@ false
"id": "IntegralAdScience",
"properties": {
"customSegmentId": {
-"description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.",
+"description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.",
"items": {
"format": "int64",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json
index fb61dfe2980..d1b6e4f6713 100644
--- a/googleapiclient/discovery_cache/documents/file.v1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1.json
@@ -907,7 +907,7 @@
}
}
},
-"revision": "20241204",
+"revision": "20250106",
"rootUrl": "https://file.googleapis.com/",
"schemas": {
"Backup": {
@@ -1448,17 +1448,17 @@
"description": "A Filestore instance.",
"id": "Instance",
"properties": {
-"configurablePerformanceEnabled": {
-"description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.",
-"readOnly": true,
-"type": "boolean"
-},
"createTime": {
"description": "Output only. The time when the instance was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
+"customPerformanceSupported": {
+"description": "Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.",
+"readOnly": true,
+"type": "boolean"
+},
"deletionProtectionEnabled": {
"description": "Optional. Indicates whether the instance is protected against deletion.",
"type": "boolean"
@@ -2044,6 +2044,12 @@
"description": "The enforced performance limits, calculated from the instance's performance configuration.",
"id": "PerformanceLimits",
"properties": {
+"maxIops": {
+"description": "Output only. The max IOPS.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
"maxReadIops": {
"description": "Output only. The max read IOPS.",
"format": "int64",
diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json
index 3f003709f2d..c73f9935cd3 100644
--- a/googleapiclient/discovery_cache/documents/file.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json
@@ -1074,7 +1074,7 @@
}
}
},
-"revision": "20241204",
+"revision": "20250106",
"rootUrl": "https://file.googleapis.com/",
"schemas": {
"Backup": {
@@ -1637,17 +1637,17 @@
"readOnly": true,
"type": "string"
},
-"configurablePerformanceEnabled": {
-"description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.",
-"readOnly": true,
-"type": "boolean"
-},
"createTime": {
"description": "Output only. The time when the instance was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
+"customPerformanceSupported": {
+"description": "Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.",
+"readOnly": true,
+"type": "boolean"
+},
"deletionProtectionEnabled": {
"description": "Optional. Indicates whether the instance is protected against deletion.",
"type": "boolean"
@@ -2313,6 +2313,12 @@
"description": "The enforced performance limits, calculated from the instance's performance configuration.",
"id": "PerformanceLimits",
"properties": {
+"maxIops": {
+"description": "Output only. The max IOPS.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
"maxReadIops": {
"description": "Output only. The max read IOPS.",
"format": "int64",
diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
index d032333f431..76a3978825b 100644
--- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json
@@ -1324,7 +1324,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250113",
"rootUrl": "https://firebase.googleapis.com/",
"schemas": {
"AddFirebaseRequest": {
@@ -2170,7 +2170,7 @@
"description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;"
},
"space": {
-"description": "The following are usually only present when code != 0 Space to which this status belongs",
+"description": "The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2;",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json
index 0ee53c9e4c3..72d94eb19f4 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json
@@ -2111,7 +2111,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AppDevExperienceFeatureSpec": {
@@ -2645,11 +2645,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -3116,7 +3111,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -3124,7 +3119,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -3354,11 +3349,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
index 69a20fd2122..62d1b382361 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
@@ -2255,7 +2255,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AnthosObservabilityFeatureSpec": {
@@ -2990,11 +2990,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -3461,7 +3456,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -3469,7 +3464,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -3709,11 +3704,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
index 9252cf4b41d..2bc8e8686bc 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
@@ -2111,7 +2111,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AnthosObservabilityFeatureSpec": {
@@ -2730,11 +2730,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -3201,7 +3196,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -3209,7 +3204,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -3449,11 +3444,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json
index 712a55252c8..290d05b8b3a 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v2.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json
@@ -471,7 +471,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AppDevExperienceState": {
@@ -700,11 +700,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -1171,7 +1166,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -1179,7 +1174,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -1329,11 +1324,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
index d45e3cdb58a..f76cda2df51 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json
@@ -471,7 +471,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AppDevExperienceState": {
@@ -700,11 +700,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -1171,7 +1166,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -1179,7 +1174,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -1329,11 +1324,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json
index c1cfd256c00..2c7db1fa124 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json
@@ -471,7 +471,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250113",
"rootUrl": "https://gkehub.googleapis.com/",
"schemas": {
"AppDevExperienceState": {
@@ -700,11 +700,6 @@
"description": "Configuration for Config Sync",
"id": "ConfigManagementConfigSync",
"properties": {
-"allowVerticalScale": {
-"deprecated": true,
-"description": "Optional. Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.",
-"type": "boolean"
-},
"enabled": {
"description": "Optional. Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.",
"type": "boolean"
@@ -1171,7 +1166,7 @@
"type": "string"
},
"secretType": {
-"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.",
+"description": "Required. Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, githubapp or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncBranch": {
@@ -1179,7 +1174,7 @@
"type": "string"
},
"syncRepo": {
-"description": "Optional. The URL of the Git repository to use as the source of truth.",
+"description": "Required. The URL of the Git repository to use as the source of truth.",
"type": "string"
},
"syncRev": {
@@ -1329,11 +1324,11 @@
"type": "string"
},
"secretType": {
-"description": "Optional. Type of secret configured for access to the Git repo.",
+"description": "Required. Type of secret configured for access to the OCI repo. Must be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The validation of this is case-sensitive.",
"type": "string"
},
"syncRepo": {
-"description": "Optional. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
+"description": "Required. The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.",
"type": "string"
},
"syncWaitSecs": {
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json
index 2d6ebd713ec..7909534c49c 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json
@@ -3704,7 +3704,7 @@
"type": "string"
},
"profile": {
-"description": "Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store.",
+"description": "Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store.",
"location": "query",
"type": "string"
},
@@ -4103,7 +4103,7 @@
"type": "string"
},
"resourceType": {
-"description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
+"description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
"location": "path",
"required": true,
"type": "string"
@@ -4935,7 +4935,7 @@
}
}
},
-"revision": "20241205",
+"revision": "20241226",
"rootUrl": "https://healthcare.googleapis.com/",
"schemas": {
"AccessDeterminationLogConfig": {
@@ -8240,7 +8240,7 @@
"id": "SearchResourcesRequest",
"properties": {
"resourceType": {
-"description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
+"description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
index cf2066eda9b..d998f5f763f 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
@@ -4574,7 +4574,7 @@
"type": "string"
},
"profile": {
-"description": "Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store.",
+"description": "Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store.",
"location": "query",
"type": "string"
},
@@ -4973,7 +4973,7 @@
"type": "string"
},
"resourceType": {
-"description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
+"description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
"location": "path",
"required": true,
"type": "string"
@@ -5858,7 +5858,7 @@
}
}
},
-"revision": "20241205",
+"revision": "20241226",
"rootUrl": "https://healthcare.googleapis.com/",
"schemas": {
"AccessDeterminationLogConfig": {
@@ -10083,7 +10083,7 @@
"id": "SearchResourcesRequest",
"properties": {
"resourceType": {
-"description": "Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
+"description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json
index 692abd0eb4d..5b5df39c946 100644
--- a/googleapiclient/discovery_cache/documents/integrations.v1.json
+++ b/googleapiclient/discovery_cache/documents/integrations.v1.json
@@ -2034,6 +2034,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"execute": {
+"description": "Executes all test cases in an integration version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:execute",
+"httpMethod": "POST",
+"id": "integrations.projects.locations.integrations.versions.testCases.execute",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/testCases:execute",
+"request": {
+"$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest"
+},
+"response": {
+"$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"executeTest": {
"description": "Executes functional test",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest",
@@ -4525,7 +4553,7 @@
}
}
},
-"revision": "20250106",
+"revision": "20250113",
"rootUrl": "https://integrations.googleapis.com/",
"schemas": {
"CrmlogErrorCode": {
@@ -11283,6 +11311,26 @@ false
},
"type": "object"
},
+"GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest": {
+"description": "Request for ExecuteTestCases.",
+"id": "GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest",
+"properties": {},
+"type": "object"
+},
+"GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse": {
+"description": "Response for ExecuteTestCases.",
+"id": "GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse",
+"properties": {
+"executeTestCaseResponses": {
+"description": "Results of each execution of test cases in an integration version.",
+"items": {
+"$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"GoogleCloudIntegrationsV1alphaExecution": {
"description": "The Execution resource contains detailed information of an individual integration execution.",
"id": "GoogleCloudIntegrationsV1alphaExecution",
diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json
index 5a254ca6460..a3f685df6a7 100644
--- a/googleapiclient/discovery_cache/documents/logging.v2.json
+++ b/googleapiclient/discovery_cache/documents/logging.v2.json
@@ -8922,7 +8922,7 @@
}
}
},
-"revision": "20241018",
+"revision": "20250110",
"rootUrl": "https://logging.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -9201,7 +9201,7 @@
"id": "CopyLogEntriesRequest",
"properties": {
"destination": {
-"description": "Required. Destination to which to copy log entries.",
+"description": "Required. Destination to which to copy log entries. For example: \"storage.googleapis.com/GCS_BUCKET\"",
"type": "string"
},
"filter": {
diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json
index a0121965bf1..b2a00846030 100644
--- a/googleapiclient/discovery_cache/documents/looker.v1.json
+++ b/googleapiclient/discovery_cache/documents/looker.v1.json
@@ -731,7 +731,7 @@
}
}
},
-"revision": "20241204",
+"revision": "20250108",
"rootUrl": "https://looker.googleapis.com/",
"schemas": {
"AdminSettings": {
@@ -1077,7 +1077,8 @@
"type": "string"
},
"customDomain": {
-"$ref": "CustomDomain"
+"$ref": "CustomDomain",
+"description": "Custom domain configuration for the instance."
},
"denyMaintenancePeriod": {
"$ref": "DenyMaintenancePeriod",
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
index 382382a7445..4f4b4729a07 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
@@ -1417,7 +1417,7 @@
}
}
},
-"revision": "20241210",
+"revision": "20250115",
"rootUrl": "https://merchantapi.googleapis.com/",
"schemas": {
"Accepted": {
@@ -1790,7 +1790,7 @@
},
"user": {
"$ref": "User",
-"description": "Required. The user to create."
+"description": "Optional. The user to create."
},
"userId": {
"description": "Required. The email address of the user (for example, `john.doe@gmail.com`).",
@@ -2493,6 +2493,13 @@ false
"returnShippingFee": {
"$ref": "ReturnShippingFee",
"description": "The return shipping fee. Should be set only when customer need to download and print the return label."
+},
+"seasonalOverrides": {
+"description": "Optional. Overrides to the general policy for orders placed during a specific set of time intervals.",
+"items": {
+"$ref": "SeasonalOverride"
+},
+"type": "array"
}
},
"type": "object"
@@ -3010,6 +3017,29 @@ false
},
"type": "object"
},
+"SeasonalOverride": {
+"description": "Next: 5",
+"id": "SeasonalOverride",
+"properties": {
+"begin": {
+"$ref": "Date",
+"description": "Required. Defines the date range when this seasonal override applies. Both begin and end are inclusive and should be in date decimal format, example 20250115. The dates of the seasonal overrides should not overlap."
+},
+"end": {
+"$ref": "Date",
+"description": "Required. seasonal override end date (inclusive)."
+},
+"label": {
+"description": "Required. Display name of this seasonal override in Merchant Center.",
+"type": "string"
+},
+"policy": {
+"$ref": "Policy",
+"description": "Required. The return policy for the given date range."
+}
+},
+"type": "object"
+},
"Service": {
"description": "Shipping service.",
"id": "Service",
diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
index add6d78d745..2a04109f7ae 100644
--- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
+++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
@@ -1698,6 +1698,81 @@
}
}
},
+"relations": {
+"methods": {
+"get": {
+"description": "Gets the details of an relation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/relations/{relationsId}",
+"httpMethod": "GET",
+"id": "migrationcenter.projects.locations.relations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/relations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Relation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists all the relations in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/relations",
+"httpMethod": "GET",
+"id": "migrationcenter.projects.locations.relations.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filtering results.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A token identifying a page of results the server should return.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. Parent value for `ListRelationsRequest`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/relations",
+"response": {
+"$ref": "ListRelationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
"reportConfigs": {
"methods": {
"create": {
@@ -2309,7 +2384,7 @@
}
}
},
-"revision": "20241205",
+"revision": "20250115",
"rootUrl": "https://migrationcenter.googleapis.com/",
"schemas": {
"AddAssetsToGroupRequest": {
@@ -4622,6 +4697,24 @@
},
"type": "object"
},
+"ListRelationsResponse": {
+"description": "Response message for listing relations.",
+"id": "ListRelationsResponse",
+"properties": {
+"nextPageToken": {
+"description": "A token identifying a page of results the server should return.",
+"type": "string"
+},
+"relations": {
+"description": "A list of relations.",
+"items": {
+"$ref": "Relation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ListReportConfigsResponse": {
"description": "Response message for listing report configs.",
"id": "ListReportConfigsResponse",
@@ -5704,6 +5797,48 @@
},
"type": "object"
},
+"Relation": {
+"description": "Message representing a relation between 2 resource.",
+"id": "Relation",
+"properties": {
+"createTime": {
+"description": "Output only. The timestamp when the relation was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"dstAsset": {
+"description": "Output only. The destination asset name in the relation.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. Identifier. The identifier of the relation.",
+"readOnly": true,
+"type": "string"
+},
+"srcAsset": {
+"description": "Output only. The source asset name in the relation.",
+"readOnly": true,
+"type": "string"
+},
+"type": {
+"description": "Optional. The type of the relation.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"LOGICAL_DATABASE",
+"DATABASE_DEPLOYMENT_HOSTING_SERVER"
+],
+"enumDescriptions": [
+"Default value.",
+"DBDeployment -> Database",
+"A relation between a machine/VM and the database deployment it hosts."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
"RemoveAssetsFromGroupRequest": {
"description": "A request to remove assets from a group.",
"id": "RemoveAssetsFromGroupRequest",
diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
index 4ab175500e7..5e962f23d13 100644
--- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
@@ -2548,7 +2548,7 @@
}
}
},
-"revision": "20241212",
+"revision": "20250115",
"rootUrl": "https://migrationcenter.googleapis.com/",
"schemas": {
"AddAssetsToGroupRequest": {
@@ -8555,7 +8555,7 @@ false
},
"computeEnginePreferences": {
"$ref": "ComputeEnginePreferences",
-"description": "Compute Engine preferences concern insights and recommendations for Compute Engine target."
+"description": "Optional. Compute Engine preferences concern insights and recommendations for Compute Engine target."
},
"networkCostParameters": {
"$ref": "VirtualMachinePreferencesNetworkCostParameters",
diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json
index 13162e25300..494f5567d82 100644
--- a/googleapiclient/discovery_cache/documents/monitoring.v3.json
+++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json
@@ -1204,6 +1204,11 @@
"name"
],
"parameters": {
+"activeOnly": {
+"description": "Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response. - If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned. - If a metric descriptor does not enumerate the compatible monitored resource types, it will be returned only if the metric type has recent data for some monitored resource type. The returned descriptor will not enumerate any monitored resource types.",
+"location": "query",
+"type": "boolean"
+},
"filter": {
"description": "Optional. If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with(\"custom.googleapis.com/\") ",
"location": "query",
@@ -2715,7 +2720,7 @@
}
}
},
-"revision": "20250102",
+"revision": "20250111",
"rootUrl": "https://monitoring.googleapis.com/",
"schemas": {
"Aggregation": {
diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json
index fcae225d735..e2375c3e9df 100644
--- a/googleapiclient/discovery_cache/documents/netapp.v1.json
+++ b/googleapiclient/discovery_cache/documents/netapp.v1.json
@@ -2097,7 +2097,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250116",
"rootUrl": "https://netapp.googleapis.com/",
"schemas": {
"ActiveDirectory": {
@@ -3117,6 +3117,11 @@
"description": "Instructions for mounting",
"type": "string"
},
+"ipAddress": {
+"description": "Output only. IP Address.",
+"readOnly": true,
+"type": "string"
+},
"protocol": {
"description": "Protocol to mount with.",
"enum": [
diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
index fe27bc8f8f3..8b82eeef1f2 100644
--- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
@@ -2097,7 +2097,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250116",
"rootUrl": "https://netapp.googleapis.com/",
"schemas": {
"ActiveDirectory": {
@@ -3117,6 +3117,11 @@
"description": "Instructions for mounting",
"type": "string"
},
+"ipAddress": {
+"description": "Output only. IP Address.",
+"readOnly": true,
+"type": "string"
+},
"protocol": {
"description": "Protocol to mount with.",
"enum": [
diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
index efb1232c2bc..6ac387f0472 100644
--- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
+++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
@@ -2863,7 +2863,7 @@
}
}
},
-"revision": "20250101",
+"revision": "20250110",
"rootUrl": "https://networkconnectivity.googleapis.com/",
"schemas": {
"AcceptHubSpokeRequest": {
@@ -3583,7 +3583,7 @@
},
"migration": {
"$ref": "Migration",
-"description": "Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use."
+"description": "Optional. Must be present if usage is set to FOR_MIGRATION."
},
"name": {
"description": "Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names",
@@ -3655,7 +3655,7 @@
"Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.",
"A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.",
"Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect.",
-"Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION, the peering value has to be set to FOR_SELF or default to FOR_SELF when unset. This value is for internal use."
+"Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION, the peering value has to be set to FOR_SELF or default to FOR_SELF when unset."
],
"type": "string"
},
@@ -3787,7 +3787,7 @@
"type": "array"
},
"producerVpcSpokes": {
-"description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.",
+"description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. Because they are directly connected throuh VPC peering, NCC export filters do not apply between the service consumer VPC spoke and any of its producer VPC spokes. This VPC spoke cannot be deleted as long as any of these producer VPC spokes are connected to the NCC Hub.",
"items": {
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
index bdbac002515..05d06ed9b20 100644
--- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
@@ -1116,7 +1116,7 @@
}
}
},
-"revision": "20250101",
+"revision": "20250110",
"rootUrl": "https://networkconnectivity.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -1399,7 +1399,7 @@
},
"migration": {
"$ref": "Migration",
-"description": "Optional. Must be present if usage is set to FOR_MIGRATION. This field is for internal use."
+"description": "Optional. Must be present if usage is set to FOR_MIGRATION."
},
"name": {
"description": "Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names",
@@ -1471,7 +1471,7 @@
"Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.",
"A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.",
"Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.",
-"Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset. This value is for internal use."
+"Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
index 0d26d63c5e2..bfd473991aa 100644
--- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json
@@ -758,7 +758,7 @@
}
}
},
-"revision": "20250101",
+"revision": "20250108",
"rootUrl": "https://networkmanagement.googleapis.com/",
"schemas": {
"AbortInfo": {
@@ -1479,6 +1479,10 @@ false
"description": "Source or destination of the Connectivity Test.",
"id": "Endpoint",
"properties": {
+"alloyDbInstance": {
+"description": "An [AlloyDB Instance](https://cloud.google.com/alloydb) URI.",
+"type": "string"
+},
"appEngineVersion": {
"$ref": "AppEngineVersionEndpoint",
"description": "An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions)."
diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json
index 4ad608c7caf..2d12cf71cde 100644
--- a/googleapiclient/discovery_cache/documents/places.v1.json
+++ b/googleapiclient/discovery_cache/documents/places.v1.json
@@ -280,7 +280,7 @@
}
}
},
-"revision": "20241231",
+"revision": "20250115",
"rootUrl": "https://places.googleapis.com/",
"schemas": {
"GoogleGeoTypeViewport": {
@@ -901,6 +901,7 @@
"enum": [
"FUEL_TYPE_UNSPECIFIED",
"DIESEL",
+"DIESEL_PLUS",
"REGULAR_UNLEADED",
"MIDGRADE",
"PREMIUM",
@@ -915,6 +916,7 @@
"LPG",
"E80",
"E85",
+"E100",
"METHANE",
"BIO_DIESEL",
"TRUCK_DIESEL"
@@ -922,6 +924,7 @@
"enumDescriptions": [
"Unspecified fuel type.",
"Diesel fuel.",
+"Diesel plus fuel.",
"Regular unleaded.",
"Midgrade.",
"Premium.",
@@ -933,9 +936,10 @@
"SP 98.",
"SP 99.",
"SP 100.",
-"LPG.",
+"Liquefied Petroleum Gas.",
"E 80.",
"E 85.",
+"E 100.",
"Methane.",
"Bio-diesel.",
"Truck diesel."
diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json
index e9b8d8e14bd..d07d93f5569 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1.json
@@ -573,7 +573,7 @@
"type": "string"
},
"updateMask": {
-"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`",
+"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1067,7 +1067,7 @@
}
}
},
-"revision": "20250104",
+"revision": "20250115",
"rootUrl": "https://redis.googleapis.com/",
"schemas": {
"AOFConfig": {
@@ -1445,6 +1445,10 @@
"description": "A cluster instance.",
"id": "Cluster",
"properties": {
+"asyncClusterEndpointsDeletionEnabled": {
+"description": "Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.",
+"type": "boolean"
+},
"authorizationMode": {
"description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.",
"enum": [
@@ -3756,7 +3760,8 @@ false
"MEMORY_UTILIZATION",
"NETWORK_CONNECTIONS",
"STORAGE_UTILIZATION",
-"STORAGE_USED_BYTES"
+"STORAGE_USED_BYTES",
+"NODE_COUNT"
],
"enumDescriptions": [
"Unspecified metric type.",
@@ -3764,7 +3769,8 @@ false
"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
"Number of network connections for a resource.",
"Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
-"Sotrage used by a resource."
+"Sotrage used by a resource.",
+"Node count for a resource. It represents the number of nodes units in a bigtable/spanner instance."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
index 340e087bc70..fdc3de17f28 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
@@ -573,7 +573,7 @@
"type": "string"
},
"updateMask": {
-"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`",
+"description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` * `cluster_endpoints`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1067,7 +1067,7 @@
}
}
},
-"revision": "20250104",
+"revision": "20250115",
"rootUrl": "https://redis.googleapis.com/",
"schemas": {
"AOFConfig": {
@@ -1445,6 +1445,10 @@
"description": "A cluster instance.",
"id": "Cluster",
"properties": {
+"asyncClusterEndpointsDeletionEnabled": {
+"description": "Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.",
+"type": "boolean"
+},
"authorizationMode": {
"description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.",
"enum": [
@@ -3763,7 +3767,8 @@ false
"MEMORY_UTILIZATION",
"NETWORK_CONNECTIONS",
"STORAGE_UTILIZATION",
-"STORAGE_USED_BYTES"
+"STORAGE_USED_BYTES",
+"NODE_COUNT"
],
"enumDescriptions": [
"Unspecified metric type.",
@@ -3771,7 +3776,8 @@ false
"Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
"Number of network connections for a resource.",
"Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).",
-"Sotrage used by a resource."
+"Sotrage used by a resource.",
+"Node count for a resource. It represents the number of nodes units in a bigtable/spanner instance."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
index ddecfa21ccb..99fb8933ed7 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -12,7 +12,7 @@
"baseUrl": "https://retail.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Retail",
-"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
+"description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/recommendations",
"fullyEncodeReservedExpansion": true,
@@ -2223,7 +2223,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250109",
"rootUrl": "https://retail.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
@@ -7773,7 +7773,7 @@
}
},
"servicePath": "",
-"title": "Vertex AI Search for Retail API",
+"title": "Vertex AI Search for commerce API",
"version": "v2",
"version_module": true
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
index 085efbe7893..4033ff4513d 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -12,7 +12,7 @@
"baseUrl": "https://retail.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Retail",
-"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
+"description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/recommendations",
"fullyEncodeReservedExpansion": true,
@@ -2744,7 +2744,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250109",
"rootUrl": "https://retail.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
@@ -8831,7 +8831,7 @@
}
},
"servicePath": "",
-"title": "Vertex AI Search for Retail API",
+"title": "Vertex AI Search for commerce API",
"version": "v2alpha",
"version_module": true
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
index 12cc2903ddc..bf4208671b4 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -12,7 +12,7 @@
"baseUrl": "https://retail.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Retail",
-"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
+"description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/recommendations",
"fullyEncodeReservedExpansion": true,
@@ -2368,7 +2368,7 @@
}
}
},
-"revision": "20250107",
+"revision": "20250109",
"rootUrl": "https://retail.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
@@ -8135,7 +8135,7 @@
}
},
"servicePath": "",
-"title": "Vertex AI Search for Retail API",
+"title": "Vertex AI Search for commerce API",
"version": "v2beta",
"version_module": true
}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
index c95a5dbe272..bcde3e62130 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
@@ -95,6 +95,16 @@
"description": "Regional Endpoint",
"endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
}
],
"fullyEncodeReservedExpansion": true,
@@ -1190,7 +1200,7 @@
}
}
},
-"revision": "20241114",
+"revision": "20250111",
"rootUrl": "https://secretmanager.googleapis.com/",
"schemas": {
"AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
index 108f9cfe6fe..156fdf43ae0 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
@@ -95,6 +95,16 @@
"description": "Regional Endpoint",
"endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
}
],
"fullyEncodeReservedExpansion": true,
@@ -710,7 +720,7 @@
}
}
},
-"revision": "20241209",
+"revision": "20250111",
"rootUrl": "https://secretmanager.googleapis.com/",
"schemas": {
"AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
index aebff2b9376..c20658225e8 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
@@ -95,6 +95,16 @@
"description": "Regional Endpoint",
"endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://secretmanager.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
}
],
"fullyEncodeReservedExpansion": true,
@@ -1190,7 +1200,7 @@
}
}
},
-"revision": "20241114",
+"revision": "20250111",
"rootUrl": "https://secretmanager.googleapis.com/",
"schemas": {
"AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json
index 8f391aebc8a..4ae3584a7c3 100644
--- a/googleapiclient/discovery_cache/documents/spanner.v1.json
+++ b/googleapiclient/discovery_cache/documents/spanner.v1.json
@@ -1461,6 +1461,35 @@
},
"databases": {
"methods": {
+"addSplitPoints": {
+"description": "Adds split points to specified tables, indexes of a database.",
+"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:addSplitPoints",
+"httpMethod": "POST",
+"id": "spanner.projects.instances.databases.addSplitPoints",
+"parameterOrder": [
+"database"
+],
+"parameters": {
+"database": {
+"description": "Required. The database on whose tables/indexes split points are to be added. Values are of the form `projects//instances//databases/`.",
+"location": "path",
+"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+database}:addSplitPoints",
+"request": {
+"$ref": "AddSplitPointsRequest"
+},
+"response": {
+"$ref": "AddSplitPointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/spanner.admin"
+]
+},
"changequorum": {
"description": "`ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.",
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:changequorum",
@@ -2515,7 +2544,7 @@
]
},
"executeSql": {
-"description": "Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.",
+"description": "Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).",
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
"httpMethod": "POST",
"id": "spanner.projects.instances.databases.sessions.executeSql",
@@ -2544,7 +2573,7 @@
]
},
"executeStreamingSql": {
-"description": "Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.",
+"description": "Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).",
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
"httpMethod": "POST",
"id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
@@ -3319,9 +3348,33 @@
}
}
},
-"revision": "20241218",
+"revision": "20250113",
"rootUrl": "https://spanner.googleapis.com/",
"schemas": {
+"AddSplitPointsRequest": {
+"description": "The request for AddSplitPoints.",
+"id": "AddSplitPointsRequest",
+"properties": {
+"initiator": {
+"description": "Optional. A user-supplied tag associated with the split points. For example, \"intital_data_load\", \"special_event_1\". Defaults to \"CloudAddSplitPointsAPI\" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.",
+"type": "string"
+},
+"splitPoints": {
+"description": "Required. The split points to add.",
+"items": {
+"$ref": "SplitPoints"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AddSplitPointsResponse": {
+"description": "The response for AddSplitPoints.",
+"id": "AddSplitPointsResponse",
+"properties": {},
+"type": "object"
+},
"AsymmetricAutoscalingOption": {
"description": "AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.",
"id": "AsymmetricAutoscalingOption",
@@ -4262,7 +4315,7 @@
"type": "string"
},
"text": {
-"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.",
+"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.",
"type": "string"
},
"timeZone": {
@@ -4569,6 +4622,10 @@
"description": "The request for ExecuteBatchDml.",
"id": "ExecuteBatchDmlRequest",
"properties": {
+"lastStatements": {
+"description": "Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.",
+"type": "boolean"
+},
"requestOptions": {
"$ref": "RequestOptions",
"description": "Common options for this request."
@@ -4626,6 +4683,10 @@
"$ref": "DirectedReadOptions",
"description": "Directed read options for this request."
},
+"lastStatement": {
+"description": "Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.",
+"type": "boolean"
+},
"paramTypes": {
"additionalProperties": {
"$ref": "Type"
@@ -4903,7 +4964,7 @@
"type": "string"
},
"defaultBackupScheduleType": {
-"description": "Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.",
+"description": "Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.",
"enum": [
"DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED",
"NONE",
@@ -4911,8 +4972,8 @@
],
"enumDescriptions": [
"Not specified.",
-"No default backup schedule will be created automatically on creation of a database within the instance.",
-"A default backup schedule will be created automatically on creation of a database within the instance. Once created, the default backup schedule can be edited or deleted just like any other backup schedule. Currently, the default backup schedule creates a full backup every 24 hours and retains the backup for a period of 7 days."
+"A default backup schedule isn't created automatically when a new database is created in the instance.",
+"A default backup schedule is created automatically when a new database is created in the instance. The default backup schedule creates a full backup every 24 hours. These full backups are retained for 7 days. You can edit or delete the default backup schedule once it's created."
],
"type": "string"
},
@@ -5253,6 +5314,20 @@
},
"type": "object"
},
+"Key": {
+"description": "A split key.",
+"id": "Key",
+"properties": {
+"keyParts": {
+"description": "Required. The column values making up the split key.",
+"items": {
+"type": "any"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"KeyRange": {
"description": "KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: \"Bob\", \"2014-09-23\" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `\"Bob\"` that occurred in the year 2015: \"start_closed\": [\"Bob\", \"2015-01-01\"] \"end_closed\": [\"Bob\", \"2015-12-31\"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `\"Bob\"` that occurred during and after the year 2000: \"start_closed\": [\"Bob\", \"2000-01-01\"] \"end_closed\": [\"Bob\"] The next example retrieves all events for `\"Bob\"`: \"start_closed\": [\"Bob\"] \"end_closed\": [\"Bob\"] To retrieve events before the year 2000: \"start_closed\": [\"Bob\"] \"end_open\": [\"Bob\", \"2000-01-01\"] The following range includes all rows in the table: \"start_closed\": [] \"end_closed\": [] This range returns all users whose `UserName` begins with any character from A to C: \"start_closed\": [\"A\"] \"end_open\": [\"D\"] This range returns all users whose `UserName` begins with B: \"start_closed\": [\"B\"] \"end_open\": [\"C\"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: \"start_closed\": [\"100\"] \"end_closed\": [\"1\"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.",
"id": "KeyRange",
@@ -6883,6 +6958,33 @@
},
"type": "object"
},
+"SplitPoints": {
+"description": "The split points of a table/index.",
+"id": "SplitPoints",
+"properties": {
+"expireTime": {
+"description": "Optional. The expiration timestamp of the split points. A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified.",
+"format": "google-datetime",
+"type": "string"
+},
+"index": {
+"description": "The index to split. If specified, the `table` field must refer to the index's base table.",
+"type": "string"
+},
+"keys": {
+"description": "Required. The list of split keys, i.e., the split boundaries.",
+"items": {
+"$ref": "Key"
+},
+"type": "array"
+},
+"table": {
+"description": "The table to split.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Statement": {
"description": "A single DML statement.",
"id": "Statement",
@@ -7103,12 +7205,14 @@
"enum": [
"TYPE_ANNOTATION_CODE_UNSPECIFIED",
"PG_NUMERIC",
-"PG_JSONB"
+"PG_JSONB",
+"PG_OID"
],
"enumDescriptions": [
"Not specified.",
"PostgreSQL compatible NUMERIC type. This annotation needs to be applied to Type instances having NUMERIC type code to specify that values of this type should be treated as PostgreSQL NUMERIC values. Currently this annotation is always needed for NUMERIC when a client interacts with PostgreSQL-enabled Spanner databases.",
-"PostgreSQL compatible JSONB type. This annotation needs to be applied to Type instances having JSON type code to specify that values of this type should be treated as PostgreSQL JSONB values. Currently this annotation is always needed for JSON when a client interacts with PostgreSQL-enabled Spanner databases."
+"PostgreSQL compatible JSONB type. This annotation needs to be applied to Type instances having JSON type code to specify that values of this type should be treated as PostgreSQL JSONB values. Currently this annotation is always needed for JSON when a client interacts with PostgreSQL-enabled Spanner databases.",
+"PostgreSQL compatible OID type. This annotation can be used by a client interacting with PostgreSQL-enabled Spanner database to specify that a value should be treated using the semantics of the OID type."
],
"type": "string"
}
@@ -7169,7 +7273,7 @@
"type": "string"
},
"protoDescriptors": {
-"description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobufFileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).",
+"description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).",
"format": "byte",
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
index 572d364f9bf..bc9bc6088b9 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
@@ -318,7 +318,7 @@
}
}
},
-"revision": "20241216",
+"revision": "20250114",
"rootUrl": "https://texttospeech.googleapis.com/",
"schemas": {
"AdvancedVoiceOptions": {
@@ -326,7 +326,7 @@
"id": "AdvancedVoiceOptions",
"properties": {
"lowLatencyJourneySynthesis": {
-"description": "Only for Journey voices. If false, the synthesis will be context aware and have higher latency.",
+"description": "Only for Journey voices. If false, the synthesis is context aware and has a higher latency.",
"type": "boolean"
}
},
@@ -351,10 +351,10 @@
"Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.",
"MP3 audio at 32kbps.",
-"Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.",
+"Opus encoded audio wrapped in an ogg container. The result is a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Audio content returned as MULAW also contains a WAV header.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header.",
-"Uncompressed 16-bit signed little-endian samples (Linear PCM). Note that as opposed to LINEAR16, audio will not be wrapped in a WAV (or any other) header."
+"Uncompressed 16-bit signed little-endian samples (Linear PCM). Note that as opposed to LINEAR16, audio won't be wrapped in a WAV (or any other) header."
],
"type": "string"
},
@@ -407,13 +407,13 @@
],
"enumDescriptions": [
"Not specified.",
-"IPA. (e.g. apple -> \u02c8\u00e6p\u0259l ) https://en.wikipedia.org/wiki/International_Phonetic_Alphabet",
-"X-SAMPA (e.g. apple -> \"{p@l\" ) https://en.wikipedia.org/wiki/X-SAMPA"
+"IPA, such as apple -> \u02c8\u00e6p\u0259l. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet",
+"X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA"
],
"type": "string"
},
"phrase": {
-"description": "The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.",
+"description": "The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.",
"type": "string"
},
"pronunciation": {
@@ -428,7 +428,7 @@
"id": "CustomPronunciations",
"properties": {
"pronunciations": {
-"description": "The pronunciation customizations to be applied.",
+"description": "The pronunciation customizations are applied.",
"items": {
"$ref": "CustomPronunciationParams"
},
@@ -606,7 +606,7 @@
"properties": {
"customPronunciations": {
"$ref": "CustomPronunciations",
-"description": "Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially)."
+"description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag."
},
"multiSpeakerMarkup": {
"$ref": "MultiSpeakerMarkup",
@@ -705,7 +705,7 @@
"type": "object"
},
"Turn": {
-"description": "A Multi-speaker turn.",
+"description": "A multi-speaker turn.",
"id": "Turn",
"properties": {
"speaker": {
@@ -803,7 +803,7 @@
},
"voiceClone": {
"$ref": "VoiceCloneParams",
-"description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration."
+"description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration."
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
index 788be18c1e5..961a6ecd300 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
@@ -261,7 +261,7 @@
}
}
},
-"revision": "20241216",
+"revision": "20250114",
"rootUrl": "https://texttospeech.googleapis.com/",
"schemas": {
"AdvancedVoiceOptions": {
@@ -269,7 +269,7 @@
"id": "AdvancedVoiceOptions",
"properties": {
"lowLatencyJourneySynthesis": {
-"description": "Only for Journey voices. If false, the synthesis will be context aware and have higher latency.",
+"description": "Only for Journey voices. If false, the synthesis is context aware and has a higher latency.",
"type": "boolean"
}
},
@@ -296,10 +296,10 @@
"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.",
"MP3 audio at 32kbps.",
"MP3 at 64kbps.",
-"Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.",
+"Opus encoded audio wrapped in an ogg container. The result is a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Audio content returned as MULAW also contains a WAV header.",
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header.",
-"Uncompressed 16-bit signed little-endian samples (Linear PCM). Note that as opposed to LINEAR16, audio will not be wrapped in a WAV (or any other) header."
+"Uncompressed 16-bit signed little-endian samples (Linear PCM). Note that as opposed to LINEAR16, audio won't be wrapped in a WAV (or any other) header."
],
"type": "string"
},
@@ -346,13 +346,13 @@
],
"enumDescriptions": [
"Not specified.",
-"IPA. (e.g. apple -> \u02c8\u00e6p\u0259l ) https://en.wikipedia.org/wiki/International_Phonetic_Alphabet",
-"X-SAMPA (e.g. apple -> \"{p@l\" ) https://en.wikipedia.org/wiki/X-SAMPA"
+"IPA, such as apple -> \u02c8\u00e6p\u0259l. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet",
+"X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA"
],
"type": "string"
},
"phrase": {
-"description": "The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.",
+"description": "The phrase to which the customization is applied. The phrase can be multiple words, such as proper nouns, but shouldn't span the length of the sentence.",
"type": "string"
},
"pronunciation": {
@@ -367,7 +367,7 @@
"id": "CustomPronunciations",
"properties": {
"pronunciations": {
-"description": "The pronunciation customizations to be applied.",
+"description": "The pronunciation customizations are applied.",
"items": {
"$ref": "CustomPronunciationParams"
},
@@ -539,7 +539,7 @@
"properties": {
"customPronunciations": {
"$ref": "CustomPronunciations",
-"description": "Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially)."
+"description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for English, French, Italian, German, and Spanish (EFIGS) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag."
},
"multiSpeakerMarkup": {
"$ref": "MultiSpeakerMarkup",
@@ -680,7 +680,7 @@
"type": "object"
},
"Turn": {
-"description": "A Multi-speaker turn.",
+"description": "A multi-speaker turn.",
"id": "Turn",
"properties": {
"speaker": {
@@ -778,7 +778,7 @@
},
"voiceClone": {
"$ref": "VoiceCloneParams",
-"description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration."
+"description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration."
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/tpu.v2.json b/googleapiclient/discovery_cache/documents/tpu.v2.json
index 4fa945974a1..4d4db0c7e31 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v2.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v2.json
@@ -887,7 +887,7 @@
}
}
},
-"revision": "20250103",
+"revision": "20250109",
"rootUrl": "https://tpu.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -915,8 +915,8 @@
"TPU v3.",
"TPU v4.",
"TPU v5lite pod.",
-"TPU v5p",
-"TPU v6e"
+"TPU v5p.",
+"TPU v6e."
],
"type": "string"
}
diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json
index e8966429e28..65090339156 100644
--- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json
+++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json
@@ -233,7 +233,7 @@
],
"parameters": {
"name": {
-"description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
+"description": "Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
@@ -526,7 +526,7 @@
}
}
},
-"revision": "20240623",
+"revision": "20250105",
"rootUrl": "https://websecurityscanner.googleapis.com/",
"schemas": {
"Authentication": {
@@ -920,6 +920,9 @@
"description": "Whether to keep scanning even if most requests return HTTP error codes.",
"type": "boolean"
},
+"latestRun": {
+"$ref": "ScanRun"
+},
"managedScan": {
"description": "Whether the scan config is managed by Web Security Scanner, output only.",
"type": "boolean"
@@ -930,7 +933,7 @@
"type": "integer"
},
"name": {
-"description": "The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
+"description": "Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.",
"type": "string"
},
"riskLevel": {
@@ -962,6 +965,27 @@
"description": "Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.",
"type": "boolean"
},
+"targetPlatforms": {
+"description": "Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.",
+"items": {
+"enum": [
+"TARGET_PLATFORM_UNSPECIFIED",
+"APP_ENGINE",
+"COMPUTE",
+"CLOUD_RUN",
+"CLOUD_FUNCTIONS"
+],
+"enumDescriptions": [
+"The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.",
+"Google App Engine service.",
+"Google Compute Engine service.",
+"Google Cloud Run service.",
+"Google Cloud Function service."
+],
+"type": "string"
+},
+"type": "array"
+},
"userAgent": {
"description": "The user agent used during scanning.",
"enum": [
diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
index 6907ecd2cc5..0c104ad5aac 100644
--- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
+++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
@@ -12,16 +12,16 @@
"description": "View members in Google Chat conversations."
},
"https://www.googleapis.com/auth/chat.messages": {
-"description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages."
+"description": "See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages."
},
"https://www.googleapis.com/auth/chat.messages.reactions": {
-"description": "See, add, and delete reactions to messages in Google Chat"
+"description": "See, add, and delete reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions.readonly": {
-"description": "View reactions to messages in Google Chat"
+"description": "View reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.readonly": {
-"description": "See messages and their associated reactions and attachments in Google Chat"
+"description": "See messages as well as their reactions and message content in Google Chat"
},
"https://www.googleapis.com/auth/chat.spaces": {
"description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat"
@@ -474,7 +474,7 @@
}
}
},
-"revision": "20241210",
+"revision": "20250114",
"rootUrl": "https://workspaceevents.googleapis.com/",
"schemas": {
"ListSubscriptionsResponse": {